summaryrefslogtreecommitdiffstats
path: root/contrib/src/boost/random/traits.hpp
blob: 971327b48d3cee08ab4d2cbebef8f1881d3f75a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/* boost random/traits.hpp header file

 *

 * Copyright John Maddock 2015

 * Distributed under the Boost Software License, Version 1.0. (See

 * accompanying file LICENSE_1_0.txt or copy at

 * http://www.boost.org/LICENSE_1_0.txt)

 *

 * See http://www.boost.org for most recent version including documentation.

 *

 * These traits classes serve two purposes: they are designed to mostly

 * work out of the box for multiprecision types (ie number types that are

 * C++ class types and not integers or floats from type-traits point of view),

 * they are also a potential point of specialization for user-defined

 * number types.

 *

 * $Id$

 */

#ifndef BOOST_RANDOM_TRAITS_HPP

#define BOOST_RANDOM_TRAITS_HPP


#include <boost/type_traits/is_signed.hpp>

#include <boost/type_traits/is_integral.hpp>

#include <boost/type_traits/make_unsigned.hpp>

#include <boost/mpl/bool.hpp>

#include <limits>


namespace boost {
namespace random {
namespace traits {
   // \cond show_private

   template <class T, bool intrinsic>
   struct make_unsigned_imp
   {
      typedef typename boost::make_unsigned<T>::type type;
   };
   template <class T>
   struct make_unsigned_imp<T, false>
   {
      BOOST_STATIC_ASSERT(std::numeric_limits<T>::is_specialized);
      BOOST_STATIC_ASSERT(std::numeric_limits<T>::is_signed == false);
      BOOST_STATIC_ASSERT(std::numeric_limits<T>::is_integer == true);
      typedef T type;
   };
   // \endcond

   /** \brief Converts the argument type T to an unsigned type.

   *

   * This trait has a single member `type` which is the unsigned type corresponding to T.

   * Note that

   * if T is signed, then member `type` *should define a type with one more bit precision than T*.  For built-in

   * types this trait defaults to `boost::make_unsigned<T>::type`.  For user defined types it simply asserts that

   * the argument type T is an unsigned integer (using std::numeric_limits).

   * User defined specializations may be provided for other cases.

   */
   template <class T>
   struct make_unsigned
   // \cond show_private

      : public make_unsigned_imp < T, boost::is_integral<T>::value > 
      // \endcond

   {};
   // \cond show_private

   template <class T, bool intrinsic>
   struct make_unsigned_or_unbounded_imp
   {
      typedef typename boost::make_unsigned<T>::type type;
   };
   template <class T>
   struct make_unsigned_or_unbounded_imp<T, false>
   {
      BOOST_STATIC_ASSERT(std::numeric_limits<T>::is_specialized);
      BOOST_STATIC_ASSERT((std::numeric_limits<T>::is_signed == false) || (std::numeric_limits<T>::is_bounded == false));
      BOOST_STATIC_ASSERT(std::numeric_limits<T>::is_integer == true);
      typedef T type;
   };
   // \endcond

   /** \brief Converts the argument type T to either an unsigned type or an unbounded integer type.

   *

   * This trait has a single member `type` which is either the unsigned type corresponding to T or an unbounded

   * integer type.  This trait is used to generate types suitable for the calculation of a range: as a result

   * if T is signed, then member `type` *should define a type with one more bit precision than T*.  For built-in

   * types this trait defaults to `boost::make_unsigned<T>::type`.  For user defined types it simply asserts that

   * the argument type T is either an unbounded integer, or an unsigned one (using std::numeric_limits).

   * User defined specializations may be provided for other cases.

   */
   template <class T>
   struct make_unsigned_or_unbounded
      // \cond show_private

      : public make_unsigned_or_unbounded_imp < T, boost::is_integral<T>::value > 
      // \endcond

   {};
   /** \brief Traits class that indicates whether type T is an integer

   */
   template <class T>
   struct is_integral
      : public mpl::bool_<boost::is_integral<T>::value || (std::numeric_limits<T>::is_integer)>
   {};
   /** \brief Traits class that indicates whether type T is a signed integer

   */
   template <class T> struct is_signed
      : public mpl::bool_ < boost::is_signed<T>::value || (std::numeric_limits<T>::is_specialized && std::numeric_limits<T>::is_integer && std::numeric_limits<T>::is_signed)>
   {};

}
}
}

#endif