2 // Copyright Christopher Kormanyos 2002 - 2013.
3 // Copyright 2011 - 2013 John Maddock.
4 // Distributed under the Boost Software License, Version 1.0.
5 // (See accompanying file LICENSE_1_0.txt or copy at
6 // http://www.boost.org/LICENSE_1_0.txt)
8 // This work is based on an earlier work:
9 // "Algorithm 910: A Portable C++ Multiple-Precision System for Special-Function Calculations",
10 // in ACM TOMS, {VOL 37, ISSUE 4, (February 2011)} (C) ACM, 2011. http://doi.acm.org/10.1145/1916461.1916469
12 // This file has no include guards or namespaces - it's expanded inline inside default_ops.hpp
17 #pragma warning(disable : 6326) // comparison of two constants
18 #pragma warning(disable : 4127) // conditional expression is constant
21 #include <boost/multiprecision/detail/standalone_config.hpp>
22 #include <boost/multiprecision/detail/no_exceptions_support.hpp>
23 #include <boost/multiprecision/detail/assert.hpp>
27 template <typename T, typename U>
28 inline void pow_imp(T& result, const T& t, const U& p, const std::integral_constant<bool, false>&)
30 // Compute the pure power of typename T t^p.
31 // Use the S-and-X binary method, as described in
32 // D. E. Knuth, "The Art of Computer Programming", Vol. 2,
33 // Section 4.6.3 . The resulting computational complexity
34 // is order log2[abs(p)].
36 using int_type = typename boost::multiprecision::detail::canonical<U, T>::type;
41 pow_imp(temp, t, p, std::integral_constant<bool, false>());
46 // This will store the result.
47 if (U(p % U(2)) != U(0))
56 // The variable x stores the binary powers of t.
59 while (U(p2 /= 2) != U(0))
61 // Square x for each binary power.
64 const bool has_binary_power = (U(p2 % U(2)) != U(0));
68 // Multiply the result with each binary power contained in the exponent.
69 eval_multiply(result, x);
74 template <typename T, typename U>
75 inline void pow_imp(T& result, const T& t, const U& p, const std::integral_constant<bool, true>&)
77 // Signed integer power, just take care of the sign then call the unsigned version:
78 using int_type = typename boost::multiprecision::detail::canonical<U, T>::type;
79 using ui_type = typename boost::multiprecision::detail::make_unsigned<U>::type ;
84 temp = static_cast<int_type>(1);
86 pow_imp(denom, t, static_cast<ui_type>(-p), std::integral_constant<bool, false>());
87 eval_divide(result, temp, denom);
90 pow_imp(result, t, static_cast<ui_type>(p), std::integral_constant<bool, false>());
95 template <typename T, typename U>
96 inline typename std::enable_if<boost::multiprecision::detail::is_integral<U>::value>::type eval_pow(T& result, const T& t, const U& p)
98 detail::pow_imp(result, t, p, boost::multiprecision::detail::is_signed<U>());
102 void hyp0F0(T& H0F0, const T& x)
104 // Compute the series representation of Hypergeometric0F0 taken from
105 // http://functions.wolfram.com/HypergeometricFunctions/Hypergeometric0F0/06/01/
106 // There are no checks on input range or parameter boundaries.
108 using ui_type = typename std::tuple_element<0, typename T::unsigned_types>::type;
110 BOOST_MP_ASSERT(&H0F0 != &x);
111 long tol = boost::multiprecision::detail::digits2<number<T, et_on> >::value();
114 T x_pow_n_div_n_fact(x);
116 eval_add(H0F0, x_pow_n_div_n_fact, ui_type(1));
119 eval_ldexp(lim, H0F0, 1 - tol);
120 if (eval_get_sign(lim) < 0)
125 const unsigned series_limit =
126 boost::multiprecision::detail::digits2<number<T, et_on> >::value() < 100
128 : boost::multiprecision::detail::digits2<number<T, et_on> >::value();
129 // Series expansion of hyperg_0f0(; ; x).
130 for (n = 2; n < series_limit; ++n)
132 eval_multiply(x_pow_n_div_n_fact, x);
133 eval_divide(x_pow_n_div_n_fact, n);
134 eval_add(H0F0, x_pow_n_div_n_fact);
135 bool neg = eval_get_sign(x_pow_n_div_n_fact) < 0;
137 x_pow_n_div_n_fact.negate();
138 if (lim.compare(x_pow_n_div_n_fact) > 0)
141 x_pow_n_div_n_fact.negate();
143 if (n >= series_limit)
144 BOOST_MP_THROW_EXCEPTION(std::runtime_error("H0F0 failed to converge"));
148 void hyp1F0(T& H1F0, const T& a, const T& x)
150 // Compute the series representation of Hypergeometric1F0 taken from
151 // http://functions.wolfram.com/HypergeometricFunctions/Hypergeometric1F0/06/01/01/
152 // and also see the corresponding section for the power function (i.e. x^a).
153 // There are no checks on input range or parameter boundaries.
155 using si_type = typename boost::multiprecision::detail::canonical<int, T>::type;
157 BOOST_MP_ASSERT(&H1F0 != &x);
158 BOOST_MP_ASSERT(&H1F0 != &a);
160 T x_pow_n_div_n_fact(x);
164 eval_multiply(H1F0, pochham_a, x_pow_n_div_n_fact);
165 eval_add(H1F0, si_type(1));
167 eval_ldexp(lim, H1F0, 1 - boost::multiprecision::detail::digits2<number<T, et_on> >::value());
168 if (eval_get_sign(lim) < 0)
174 const si_type series_limit =
175 boost::multiprecision::detail::digits2<number<T, et_on> >::value() < 100
177 : boost::multiprecision::detail::digits2<number<T, et_on> >::value();
178 // Series expansion of hyperg_1f0(a; ; x).
179 for (n = 2; n < series_limit; n++)
181 eval_multiply(x_pow_n_div_n_fact, x);
182 eval_divide(x_pow_n_div_n_fact, n);
184 eval_multiply(pochham_a, ap);
185 eval_multiply(term, pochham_a, x_pow_n_div_n_fact);
186 eval_add(H1F0, term);
187 if (eval_get_sign(term) < 0)
189 if (lim.compare(term) >= 0)
192 if (n >= series_limit)
193 BOOST_MP_THROW_EXCEPTION(std::runtime_error("H1F0 failed to converge"));
197 void eval_exp(T& result, const T& x)
199 static_assert(number_category<T>::value == number_kind_floating_point, "The exp function is only valid for floating point types.");
207 using ui_type = typename boost::multiprecision::detail::canonical<unsigned, T>::type;
208 using si_type = typename boost::multiprecision::detail::canonical<int, T>::type ;
209 using exp_type = typename T::exponent_type ;
210 using canonical_exp_type = typename boost::multiprecision::detail::canonical<exp_type, T>::type;
212 // Handle special arguments.
213 int type = eval_fpclassify(x);
214 bool isneg = eval_get_sign(x) < 0;
215 if (type == static_cast<int>(FP_NAN))
221 else if (type == static_cast<int>(FP_INFINITE))
224 result = ui_type(0u);
229 else if (type == static_cast<int>(FP_ZERO))
235 // Get local copy of argument and force it to be positive.
241 // Check the range of the argument.
242 if (xx.compare(si_type(1)) <= 0)
245 // Use series for exp(x) - 1:
248 BOOST_IF_CONSTEXPR(std::numeric_limits<number<T, et_on> >::is_specialized)
249 lim = std::numeric_limits<number<T, et_on> >::epsilon().backend();
253 eval_ldexp(lim, result, 1 - boost::multiprecision::detail::digits2<number<T, et_on> >::value());
259 eval_subtract(result, exp_series);
261 eval_add(result, exp_series);
262 eval_multiply(exp_series, xx);
263 eval_divide(exp_series, ui_type(k));
264 eval_add(result, exp_series);
265 while (exp_series.compare(lim) > 0)
268 eval_multiply(exp_series, xx);
269 eval_divide(exp_series, ui_type(k));
270 if (isneg && (k & 1))
271 eval_subtract(result, exp_series);
273 eval_add(result, exp_series);
278 // Check for pure-integer arguments which can be either signed or unsigned.
279 typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type ll;
280 eval_trunc(exp_series, x);
281 eval_convert_to(&ll, exp_series);
282 if (x.compare(ll) == 0)
284 detail::pow_imp(result, get_constant_e<T>(), ll, std::integral_constant<bool, true>());
287 else if (exp_series.compare(x) == 0)
289 // We have a value that has no fractional part, but is too large to fit
290 // in a long long, in this situation the code below will fail, so
291 // we're just going to assume that this will overflow:
295 result = std::numeric_limits<number<T> >::has_infinity ? std::numeric_limits<number<T> >::infinity().backend() : (std::numeric_limits<number<T> >::max)().backend();
299 // The algorithm for exp has been taken from MPFUN.
300 // exp(t) = [ (1 + r + r^2/2! + r^3/3! + r^4/4! ...)^p2 ] * 2^n
301 // where p2 is a power of 2 such as 2048, r = t_prime / p2, and
302 // t_prime = t - n*ln2, with n chosen to minimize the absolute
303 // value of t_prime. In the resulting Taylor series, which is
304 // implemented as a hypergeometric function, |r| is bounded by
305 // ln2 / p2. For small arguments, no scaling is done.
307 // Compute the exponential series of the (possibly) scaled argument.
309 eval_divide(result, xx, get_constant_ln2<T>());
311 eval_convert_to(&n, result);
313 if (n == (std::numeric_limits<exp_type>::max)())
315 // Exponent is too large to fit in our exponent type:
319 result = std::numeric_limits<number<T> >::has_infinity ? std::numeric_limits<number<T> >::infinity().backend() : (std::numeric_limits<number<T> >::max)().backend();
323 // The scaling is 2^11 = 2048.
324 const si_type p2 = static_cast<si_type>(si_type(1) << 11);
326 eval_multiply(exp_series, get_constant_ln2<T>(), static_cast<canonical_exp_type>(n));
327 eval_subtract(exp_series, xx);
328 eval_divide(exp_series, p2);
330 hyp0F0(result, exp_series);
332 detail::pow_imp(exp_series, result, p2, std::integral_constant<bool, true>());
334 eval_ldexp(result, result, n);
335 eval_multiply(exp_series, result);
338 eval_divide(result, ui_type(1), exp_series);
344 void eval_log(T& result, const T& arg)
346 static_assert(number_category<T>::value == number_kind_floating_point, "The log function is only valid for floating point types.");
348 // We use a variation of http://dlmf.nist.gov/4.45#i
349 // using frexp to reduce the argument to x * 2^n,
350 // then let y = x - 1 and compute:
351 // log(x) = log(2) * n + log1p(1 + y)
353 using ui_type = typename boost::multiprecision::detail::canonical<unsigned, T>::type;
354 using exp_type = typename T::exponent_type ;
355 using canonical_exp_type = typename boost::multiprecision::detail::canonical<exp_type, T>::type;
356 using fp_type = typename std::tuple_element<0, typename T::float_types>::type ;
357 int s = eval_signbit(arg);
358 switch (eval_fpclassify(arg))
370 result = std::numeric_limits<number<T> >::has_infinity ? std::numeric_limits<number<T> >::infinity().backend() : (std::numeric_limits<number<T> >::max)().backend();
377 result = std::numeric_limits<number<T> >::quiet_NaN().backend();
384 eval_frexp(t, arg, &e);
385 bool alternate = false;
387 if (t.compare(fp_type(2) / fp_type(3)) <= 0)
394 eval_multiply(result, get_constant_ln2<T>(), canonical_exp_type(e));
395 INSTRUMENT_BACKEND(result);
396 eval_subtract(t, ui_type(1)); /* -0.3 <= t <= 0.3 */
398 t.negate(); /* 0 <= t <= 0.33333 */
406 eval_subtract(result, t);
408 BOOST_IF_CONSTEXPR(std::numeric_limits<number<T, et_on> >::is_specialized)
409 eval_multiply(lim, result, std::numeric_limits<number<T, et_on> >::epsilon().backend());
411 eval_ldexp(lim, result, 1 - boost::multiprecision::detail::digits2<number<T, et_on> >::value());
412 if (eval_get_sign(lim) < 0)
414 INSTRUMENT_BACKEND(lim);
420 eval_multiply(pow, t);
421 eval_divide(t2, pow, k);
422 INSTRUMENT_BACKEND(t2);
423 if (alternate && ((k & 1) != 0))
424 eval_add(result, t2);
426 eval_subtract(result, t2);
427 INSTRUMENT_BACKEND(result);
428 } while (lim.compare(t2) < 0);
432 const T& get_constant_log10()
434 static BOOST_MP_THREAD_LOCAL T result;
435 static BOOST_MP_THREAD_LOCAL long digits = 0;
436 if ((digits != boost::multiprecision::detail::digits2<number<T> >::value()))
438 using ui_type = typename boost::multiprecision::detail::canonical<unsigned, T>::type;
441 eval_log(result, ten);
442 digits = boost::multiprecision::detail::digits2<number<T> >::value();
449 void eval_log10(T& result, const T& arg)
451 static_assert(number_category<T>::value == number_kind_floating_point, "The log10 function is only valid for floating point types.");
452 eval_log(result, arg);
453 eval_divide(result, get_constant_log10<T>());
456 template <class R, class T>
457 inline void eval_log2(R& result, const T& a)
460 eval_divide(result, get_constant_ln2<R>());
463 template <typename T>
464 inline void eval_pow(T& result, const T& x, const T& a)
466 static_assert(number_category<T>::value == number_kind_floating_point, "The pow function is only valid for floating point types.");
467 using si_type = typename boost::multiprecision::detail::canonical<int, T>::type;
468 using fp_type = typename std::tuple_element<0, typename T::float_types>::type ;
470 if ((&result == &x) || (&result == &a))
478 if ((a.compare(si_type(1)) == 0) || (x.compare(si_type(1)) == 0))
483 if (a.compare(si_type(0)) == 0)
489 int type = eval_fpclassify(x);
494 switch (eval_fpclassify(a))
503 // Need to check for a an odd integer as a special case:
506 typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type i;
507 eval_convert_to(&i, a);
508 if (a.compare(i) == 0)
514 result = std::numeric_limits<number<T> >::infinity().backend();
521 result = std::numeric_limits<number<T> >::infinity().backend();
534 BOOST_MP_CATCH(const std::exception&)
544 result = std::numeric_limits<number<T> >::infinity().backend();
559 int s = eval_get_sign(a);
572 eval_divide(result, si_type(1), da);
576 typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type an;
577 typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type max_an =
578 std::numeric_limits<typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type>::is_specialized ? (std::numeric_limits<typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type>::max)() : static_cast<typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type>(1) << (sizeof(typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type) * CHAR_BIT - 2);
579 typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type min_an =
580 std::numeric_limits<typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type>::is_specialized ? (std::numeric_limits<typename boost::multiprecision::detail::canonical<std::intmax_t, T>::type>::min)() : -min_an;
585 eval_convert_to(&an, a);
586 if (a.compare(an) == 0)
588 detail::pow_imp(result, x, an, std::integral_constant<bool, true>());
592 BOOST_MP_CATCH(const std::exception&)
594 // conversion failed, just fall through, value is not an integer.
595 an = (std::numeric_limits<std::intmax_t>::max)();
598 if ((eval_get_sign(x) < 0))
600 typename boost::multiprecision::detail::canonical<std::uintmax_t, T>::type aun;
603 eval_convert_to(&aun, a);
604 if (a.compare(aun) == 0)
608 eval_pow(result, fa, a);
614 BOOST_MP_CATCH(const std::exception&)
616 // conversion failed, just fall through, value is not an integer.
620 eval_floor(result, a);
621 // -1^INF is a special case in C99:
622 if ((x.compare(si_type(-1)) == 0) && (eval_fpclassify(a) == FP_INFINITE))
626 else if (a.compare(result) == 0)
628 // exponent is so large we have no fractional part:
629 if (x.compare(si_type(-1)) < 0)
631 result = std::numeric_limits<number<T, et_on> >::infinity().backend();
638 else if (type == FP_INFINITE)
640 result = std::numeric_limits<number<T, et_on> >::infinity().backend();
642 else BOOST_IF_CONSTEXPR (std::numeric_limits<number<T, et_on> >::has_quiet_NaN)
644 result = std::numeric_limits<number<T, et_on> >::quiet_NaN().backend();
649 BOOST_MP_THROW_EXCEPTION(std::domain_error("Result of pow is undefined or non-real and there is no NaN for this number type."));
656 eval_subtract(da, a, an);
658 if ((x.compare(fp_type(0.5)) >= 0) && (x.compare(fp_type(0.9)) < 0) && (an < max_an) && (an > min_an))
660 if (a.compare(fp_type(1e-5f)) <= 0)
662 // Series expansion for small a.
670 // Series expansion for moderately sized x. Note that for large power of a,
671 // the power of the integer part of a is calculated using the pown function.
677 hyp1F0(result, da, t);
678 detail::pow_imp(t, x, an, std::integral_constant<bool, true>());
679 eval_multiply(result, t);
687 hyp1F0(result, da, t);
693 // Series expansion for pow(x, a). Note that for large power of a, the power
694 // of the integer part of a is calculated using the pown function.
698 eval_multiply(t, da);
700 detail::pow_imp(t, x, an, std::integral_constant<bool, true>());
701 eval_multiply(result, t);
712 template <class T, class A>
713 #if BOOST_WORKAROUND(BOOST_MSVC, < 1800)
714 inline typename std::enable_if<!boost::multiprecision::detail::is_integral<A>::value, void>::type
716 inline typename std::enable_if<is_compatible_arithmetic_type<A, number<T> >::value && !boost::multiprecision::detail::is_integral<A>::value, void>::type
718 eval_pow(T& result, const T& x, const A& a)
720 // Note this one is restricted to float arguments since pow.hpp already has a version for
721 // integer powers....
722 using canonical_type = typename boost::multiprecision::detail::canonical<A, T>::type ;
723 using cast_type = typename std::conditional<std::is_same<A, canonical_type>::value, T, canonical_type>::type;
726 eval_pow(result, x, c);
729 template <class T, class A>
730 #if BOOST_WORKAROUND(BOOST_MSVC, < 1800)
733 inline typename std::enable_if<is_compatible_arithmetic_type<A, number<T> >::value, void>::type
735 eval_pow(T& result, const A& x, const T& a)
737 using canonical_type = typename boost::multiprecision::detail::canonical<A, T>::type ;
738 using cast_type = typename std::conditional<std::is_same<A, canonical_type>::value, T, canonical_type>::type;
741 eval_pow(result, c, a);
745 void eval_exp2(T& result, const T& arg)
747 static_assert(number_category<T>::value == number_kind_floating_point, "The log function is only valid for floating point types.");
749 // Check for pure-integer arguments which can be either signed or unsigned.
750 typename boost::multiprecision::detail::canonical<typename T::exponent_type, T>::type i;
754 eval_trunc(temp, arg);
755 eval_convert_to(&i, temp);
756 if (arg.compare(i) == 0)
758 temp = static_cast<typename std::tuple_element<0, typename T::unsigned_types>::type>(1u);
759 eval_ldexp(result, temp, i);
763 #ifdef BOOST_MP_MATH_AVAILABLE
764 BOOST_MP_CATCH(const boost::math::rounding_error&)
768 BOOST_MP_CATCH(const std::runtime_error&)
773 temp = static_cast<typename std::tuple_element<0, typename T::unsigned_types>::type>(2u);
774 eval_pow(result, temp, arg);
780 void small_sinh_series(T x, T& result)
782 using ui_type = typename boost::multiprecision::detail::canonical<unsigned, T>::type;
783 bool neg = eval_get_sign(x) < 0;
788 eval_multiply(mult, x);
793 eval_ldexp(lim, lim, 1 - boost::multiprecision::detail::digits2<number<T, et_on> >::value());
797 eval_multiply(p, mult);
801 } while (p.compare(lim) >= 0);
807 void sinhcosh(const T& x, T* p_sinh, T* p_cosh)
809 using ui_type = typename boost::multiprecision::detail::canonical<unsigned, T>::type;
810 using fp_type = typename std::tuple_element<0, typename T::float_types>::type ;
812 switch (eval_fpclassify(x))
823 if (eval_get_sign(x) < 0)
831 *p_cosh = ui_type(1);
836 bool small_sinh = eval_get_sign(x) < 0 ? x.compare(fp_type(-0.5)) > 0 : x.compare(fp_type(0.5)) < 0;
838 if (p_cosh || !small_sinh)
842 eval_divide(e_mx, ui_type(1), e_px);
843 if (eval_signbit(e_mx) != eval_signbit(e_px))
844 e_mx.negate(); // Handles lack of signed zero in some types
850 small_sinh_series(x, *p_sinh);
854 eval_subtract(*p_sinh, e_px, e_mx);
855 eval_ldexp(*p_sinh, *p_sinh, -1);
860 eval_add(*p_cosh, e_px, e_mx);
861 eval_ldexp(*p_cosh, *p_cosh, -1);
866 small_sinh_series(x, *p_sinh);
870 } // namespace detail
873 inline void eval_sinh(T& result, const T& x)
875 static_assert(number_category<T>::value == number_kind_floating_point, "The sinh function is only valid for floating point types.");
876 detail::sinhcosh(x, &result, static_cast<T*>(0));
880 inline void eval_cosh(T& result, const T& x)
882 static_assert(number_category<T>::value == number_kind_floating_point, "The cosh function is only valid for floating point types.");
883 detail::sinhcosh(x, static_cast<T*>(0), &result);
887 inline void eval_tanh(T& result, const T& x)
889 static_assert(number_category<T>::value == number_kind_floating_point, "The tanh function is only valid for floating point types.");
891 detail::sinhcosh(x, &result, &c);
892 if ((eval_fpclassify(result) == FP_INFINITE) && (eval_fpclassify(c) == FP_INFINITE))
894 bool s = eval_signbit(result) != eval_signbit(c);
895 result = static_cast<typename std::tuple_element<0, typename T::unsigned_types>::type>(1u);
900 eval_divide(result, c);