round.hpp 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. // Copyright John Maddock 2007.
  2. // Use, modification and distribution are subject to the
  3. // Boost Software License, Version 1.0. (See accompanying file
  4. // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  5. #ifndef BOOST_MATH_ROUND_HPP
  6. #define BOOST_MATH_ROUND_HPP
  7. #ifdef _MSC_VER
  8. #pragma once
  9. #endif
  10. #include <boost/math/tools/config.hpp>
  11. #include <boost/math/policies/error_handling.hpp>
  12. #include <boost/math/special_functions/math_fwd.hpp>
  13. #include <boost/math/special_functions/fpclassify.hpp>
  14. namespace boost{ namespace math{
  15. namespace detail{
  16. template <class T, class Policy>
  17. inline typename tools::promote_args<T>::type round(const T& v, const Policy& pol, const std::false_type&)
  18. {
  19. BOOST_MATH_STD_USING
  20. typedef typename tools::promote_args<T>::type result_type;
  21. if(!(boost::math::isfinite)(v))
  22. return policies::raise_rounding_error("boost::math::round<%1%>(%1%)", 0, static_cast<result_type>(v), static_cast<result_type>(v), pol);
  23. //
  24. // The logic here is rather convoluted, but avoids a number of traps,
  25. // see discussion here https://github.com/boostorg/math/pull/8
  26. //
  27. if (-0.5 < v && v < 0.5)
  28. {
  29. // special case to avoid rounding error on the direct
  30. // predecessor of +0.5 resp. the direct successor of -0.5 in
  31. // IEEE floating point types
  32. return static_cast<result_type>(0);
  33. }
  34. else if (v > 0)
  35. {
  36. // subtract v from ceil(v) first in order to avoid rounding
  37. // errors on largest representable integer numbers
  38. result_type c(ceil(v));
  39. return 0.5 < c - v ? c - 1 : c;
  40. }
  41. else
  42. {
  43. // see former branch
  44. result_type f(floor(v));
  45. return 0.5 < v - f ? f + 1 : f;
  46. }
  47. }
  48. template <class T, class Policy>
  49. inline typename tools::promote_args<T>::type round(const T& v, const Policy&, const std::true_type&)
  50. {
  51. return v;
  52. }
  53. } // namespace detail
  54. template <class T, class Policy>
  55. inline typename tools::promote_args<T>::type round(const T& v, const Policy& pol)
  56. {
  57. return detail::round(v, pol, std::integral_constant<bool, detail::is_integer_for_rounding<T>::value>());
  58. }
  59. template <class T>
  60. inline typename tools::promote_args<T>::type round(const T& v)
  61. {
  62. return round(v, policies::policy<>());
  63. }
  64. //
  65. // The following functions will not compile unless T has an
  66. // implicit conversion to the integer types. For user-defined
  67. // number types this will likely not be the case. In that case
  68. // these functions should either be specialized for the UDT in
  69. // question, or else overloads should be placed in the same
  70. // namespace as the UDT: these will then be found via argument
  71. // dependent lookup. See our concept archetypes for examples.
  72. //
  73. // Non-standard numeric limits syntax "(std::numeric_limits<int>::max)()"
  74. // is to avoid macro substiution from MSVC
  75. // https://stackoverflow.com/questions/27442885/syntax-error-with-stdnumeric-limitsmax
  76. //
  77. template <class T, class Policy>
  78. inline int iround(const T& v, const Policy& pol)
  79. {
  80. BOOST_MATH_STD_USING
  81. typedef typename tools::promote_args<T>::type result_type;
  82. T r = boost::math::round(v, pol);
  83. if(r > static_cast<result_type>((std::numeric_limits<int>::max)()) || r < static_cast<result_type>((std::numeric_limits<int>::min)()))
  84. return static_cast<int>(policies::raise_rounding_error("boost::math::iround<%1%>(%1%)", 0, v, 0, pol));
  85. return static_cast<int>(r);
  86. }
  87. template <class T>
  88. inline int iround(const T& v)
  89. {
  90. return iround(v, policies::policy<>());
  91. }
  92. template <class T, class Policy>
  93. inline long lround(const T& v, const Policy& pol)
  94. {
  95. BOOST_MATH_STD_USING
  96. typedef typename tools::promote_args<T>::type result_type;
  97. T r = boost::math::round(v, pol);
  98. if(r > static_cast<result_type>((std::numeric_limits<long>::max)()) || r < static_cast<result_type>((std::numeric_limits<long>::min)()))
  99. return static_cast<long int>(policies::raise_rounding_error("boost::math::lround<%1%>(%1%)", 0, v, 0L, pol));
  100. return static_cast<long int>(r);
  101. }
  102. template <class T>
  103. inline long lround(const T& v)
  104. {
  105. return lround(v, policies::policy<>());
  106. }
  107. #ifdef BOOST_HAS_LONG_LONG
  108. template <class T, class Policy>
  109. inline boost::long_long_type llround(const T& v, const Policy& pol)
  110. {
  111. BOOST_MATH_STD_USING
  112. typedef typename tools::promote_args<T>::type result_type;
  113. T r = boost::math::round(v, pol);
  114. if(r > static_cast<result_type>((std::numeric_limits<boost::long_long_type>::max)()) ||
  115. r < static_cast<result_type>((std::numeric_limits<boost::long_long_type>::min)()))
  116. {
  117. return static_cast<boost::long_long_type>(policies::raise_rounding_error("boost::math::llround<%1%>(%1%)", 0, v, static_cast<boost::long_long_type>(0), pol));
  118. }
  119. return static_cast<boost::long_long_type>(r);
  120. }
  121. template <class T>
  122. inline boost::long_long_type llround(const T& v)
  123. {
  124. return llround(v, policies::policy<>());
  125. }
  126. #endif
  127. }} // namespaces
  128. #endif // BOOST_MATH_ROUND_HPP