OpenWalnut  1.4.0
WLimits.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WLIMITS_H
26 #define WLIMITS_H
27 
28 #include <stdint.h> // since <cstdint> is part of c++0x upcoming standard
29 
30 #include <cstddef>
31 
32 #ifndef Q_MOC_RUN
33 #include <boost/math/special_functions/fpclassify.hpp> // isnan, isinf
34 #endif
35 
36 /**
37  * Project wide limits for different quantities.
38  */
39 namespace wlimits
40 {
41  extern const double MAX_DOUBLE; //!< Maximum double value
42 
43  extern const float MAX_FLOAT; //!< Maximum float value
44 
45  extern const size_t MAX_SIZE_T; //!< Maximum size value
46 
47  extern const int32_t MAX_INT32_T; //!< Maximum int32_t value
48 
49  extern const double MIN_DOUBLE; //!< Positive minimum double value
50 
51  /**
52  * Smallest double such: 1.0 + DBL_EPS == 1.0 is still true.
53  */
54  extern const double DBL_EPS;
55 
56  /**
57  * Smallest float such: 1.0 + FLT_EPS == 1.0 is still true.
58  */
59  extern const float FLT_EPS;
60 
61  /**
62  * Determines if a number is considered as NaN (aka Not a Number) or not.
63  *
64  * \note The reason for using here a wrapper to cmath's isnan is that it is only included in C99 which is not part of any existing C++ standard yet.
65  *
66  * \param value The value to be checked
67  *
68  * \return True if the value is a NaN, false otherwise.
69  */
70  template< typename T > bool isNaN( T value );
71 
72  /**
73  * Determines if a number is considered as infinity or not.
74  *
75  * \note The reason for using here a wrapper to cmath's isinf is that it is only included in C99 which is not part of any existing C++ standard yet.
76  *
77  * \param value The value to be checked
78  *
79  * \return True if the value is infinity, false otherwise.
80  */
81  template< typename T > bool isInf( T value );
82 }
83 
84 template< typename T > bool wlimits::isNaN( T value )
85 {
86  return ( boost::math::isnan )( value );
87 }
88 
89 template< typename T > bool wlimits::isInf( T value )
90 {
91  return ( boost::math::isinf )( value );
92 }
93 
94 #endif // WLIMITS_H
const double MIN_DOUBLE
Positive minimum double value.
Definition: WLimits.cpp:35
const size_t MAX_SIZE_T
Maximum size value.
Definition: WLimits.cpp:33
const float MAX_FLOAT
Maximum float value.
Definition: WLimits.cpp:32
Project wide limits for different quantities.
Definition: WLimits.cpp:29
const float FLT_EPS
Smallest float such: 1.0 + FLT_EPS == 1.0 is still true.
Definition: WLimits.cpp:37
const double DBL_EPS
Smallest double such: 1.0 + DBL_EPS == 1.0 is still true.
Definition: WLimits.cpp:36
bool isNaN(T value)
Determines if a number is considered as NaN (aka Not a Number) or not.
Definition: WLimits.h:84
bool isInf(T value)
Determines if a number is considered as infinity or not.
Definition: WLimits.h:89
const double MAX_DOUBLE
Maximum double value.
Definition: WLimits.cpp:31
const int32_t MAX_INT32_T
Maximum int32_t value.
Definition: WLimits.cpp:34