boost/math/constants/constants.hpp

   1 //  Copyright John Maddock 2005-2006.
   2 //  Copyright Paul A. Bristow 2006-7.
   3 //  Use, modification and distribution are subject to the
   4 //  Boost Software License, Version 1.0. (See accompanying file
   5 //  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6
   7 #ifndef BOOST_MATH_CONSTANTS_CONSTANTS_INCLUDED
   8 #define BOOST_MATH_CONSTANTS_CONSTANTS_INCLUDED
   9
  10 #include <boost/math/tools/config.hpp>
  11 #ifdef BOOST_MSVC
  12 #pragma warning(push)
  13 #pragma warning(disable: 4127 4701)
  14 #endif
  15 #include <boost/lexical_cast.hpp>
  16 #ifdef BOOST_MSVC
  17 #pragma warning(pop)
  18 #endif
  19
  20 namespace boost{ namespace math
  21 {
  22   namespace constants
  23   {
  24     // To permit other calculations at about 100 decimal digits with NTL::RR type,
  25     // it is obviously necessary to define constants to this accuracy.
  26
  27     // However, some compilers do not accept decimal digits strings as long as this.
  28     // So the constant is split into two parts, with the 1st containing at least
  29     // long double precision, and the 2nd zero if not needed or known.
  30     // The 3rd part permits an exponent to be provided if necessary (use zero if none) -
  31     // the other two parameters may only contain decimal digits (and sign and decimal point),
  32     // and may NOT include an exponent like 1.234E99.
  33     // The second digit string is only used if T is a User-Defined Type,
  34     // when the constant is converted to a long string literal and lexical_casted to type T.
  35     // (This is necessary because you can't use a numeric constant
  36     // since even a long double might not have enough digits).
  37
  38
  39   #define BOOST_DEFINE_MATH_CONSTANT(name, x, y, exp)\
  40    template <class T> inline T name(BOOST_MATH_EXPLICIT_TEMPLATE_TYPE(T))\
  41    {\
  42       static const T result = ::boost::lexical_cast<T>(BOOST_STRINGIZE(BOOST_JOIN(BOOST_JOIN(x, y), BOOST_JOIN(e, exp))));\
  43       return result;\
  44    }\
  45    template <> inline float name<float>(BOOST_MATH_EXPLICIT_TEMPLATE_TYPE_SPEC(float))\
  46    { return BOOST_JOIN(BOOST_JOIN(x, BOOST_JOIN(e, exp)), F); }\
  47    template <> inline double name<double>(BOOST_MATH_EXPLICIT_TEMPLATE_TYPE_SPEC(double))\
  48    { return BOOST_JOIN(x, BOOST_JOIN(e, exp)); }\
  49    template <> inline long double name<long double>(BOOST_MATH_EXPLICIT_TEMPLATE_TYPE_SPEC(long double))\
  50    { return BOOST_JOIN(BOOST_JOIN(x, BOOST_JOIN(e, exp)), L); }
  51
  52   BOOST_DEFINE_MATH_CONSTANT(pi, 3.141592653589793238462643383279502884197169399375105820974944, 59230781640628620899862803482534211706798214808651328230664709384460955058223172535940812848111745028410270193852110555964462294895493038196, 0)
  53   BOOST_DEFINE_MATH_CONSTANT(root_pi, 1.7724538509055160272981674833411451827975, 0, 0)
  54   BOOST_DEFINE_MATH_CONSTANT(root_half_pi, 1.253314137315500251207882642405522626503, 0, 0)
  55   BOOST_DEFINE_MATH_CONSTANT(root_two_pi, 2.506628274631000502415765284811045253007, 0, 0)
  56   BOOST_DEFINE_MATH_CONSTANT(root_ln_four, 1.1774100225154746910115693264596996377473856893858205385225257565000, 2658854698492680841813836877081, 0)
  57   BOOST_DEFINE_MATH_CONSTANT(e, 2.7182818284590452353602874713526624977572470936999595749669676, 27724076630353547594571382178525166427427466391932003059921817413596629043572900334295260595630738132328627943490763233829880753195251019011, 0)
  58   BOOST_DEFINE_MATH_CONSTANT(half, 0.5, 0, 0)
  59   BOOST_DEFINE_MATH_CONSTANT(euler,    0.577215664901532860606512090082402431042159335939923598805, 76723488486, 0)
  60   BOOST_DEFINE_MATH_CONSTANT(root_two, 1.414213562373095048801688724209698078569671875376948073, 17667973799073247846210703885038753432764157273501384623091229702492483605585073721264412149709993583141322266592750559275579995050115278206, 0)
  61   BOOST_DEFINE_MATH_CONSTANT(ln_two,   0.693147180559945309417232121458176568075500134360255254, 120680009493393621969694715605863326996418687, 0)
  62   BOOST_DEFINE_MATH_CONSTANT(ln_ln_two,  -0.36651292058166432701243915823266946945426344783710526305367771367056, 16153193527385494558228566989083583025230453648347655663425171940646634, 0)
  63   BOOST_DEFINE_MATH_CONSTANT(third, 0.3333333333333333333333333333333333333333333333333333333333333333333333, 3333333333333333333333333333333333333333333333333333333333333333333333333, 0)
  64   BOOST_DEFINE_MATH_CONSTANT(twothirds, 0.66666666666666666666666666666666666666666666666666666666666666666666, 66666666666666666666666666666666666666666666666666666666666666666666667, 0)
  65   BOOST_DEFINE_MATH_CONSTANT(pi_minus_three, 0.141592653589793238462643383279502884197169399375105820974944, 59230781640628620899862803482534211706798214808651328230664709384460955058223172535940812848111745028410270193852110555964462294895493038196, 0)
  66   BOOST_DEFINE_MATH_CONSTANT(four_minus_pi, 0.85840734641020676153735661672049711580283060062489417902505540769218359, 0, 0)
  67   BOOST_DEFINE_MATH_CONSTANT(pow23_four_minus_pi, 0.79531676737159754434839533505680658072763917332771320544530223438582161, 0, 0)
  68   BOOST_DEFINE_MATH_CONSTANT(exp_minus_half, 0.6065306597126334236037995349911804534419181354871869556828921587350565194137, 484239986476115079894560, 0)
  69
  70
  71   } // namespace constants
  72 } // namespace math
  73 } // namespace boost
  74
  75 #endif // BOOST_MATH_CONSTANTS_CONSTANTS_INCLUDED