ellint_rd.hpp 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. // Copyright (c) 2006 Xiaogang Zhang, 2015 John Maddock.
  2. // Copyright (c) 2024 Matt Borland
  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. // History:
  8. // XZ wrote the original of this file as part of the Google
  9. // Summer of Code 2006. JM modified it slightly to fit into the
  10. // Boost.Math conceptual framework better.
  11. // Updated 2015 to use Carlson's latest methods.
  12. #ifndef BOOST_MATH_ELLINT_RD_HPP
  13. #define BOOST_MATH_ELLINT_RD_HPP
  14. #ifdef _MSC_VER
  15. #pragma once
  16. #endif
  17. #include <boost/math/tools/config.hpp>
  18. #include <boost/math/tools/promotion.hpp>
  19. #include <boost/math/special_functions/math_fwd.hpp>
  20. #include <boost/math/special_functions/ellint_rc.hpp>
  21. #include <boost/math/policies/error_handling.hpp>
  22. // Carlson's elliptic integral of the second kind
  23. // R_D(x, y, z) = R_J(x, y, z, z) = 1.5 * \int_{0}^{\infty} [(t+x)(t+y)]^{-1/2} (t+z)^{-3/2} dt
  24. // Carlson, Numerische Mathematik, vol 33, 1 (1979)
  25. namespace boost { namespace math { namespace detail{
  26. template <typename T, typename Policy>
  27. BOOST_MATH_GPU_ENABLED T ellint_rd_imp(T x, T y, T z, const Policy& pol)
  28. {
  29. BOOST_MATH_STD_USING
  30. constexpr auto function = "boost::math::ellint_rd<%1%>(%1%,%1%,%1%)";
  31. if(x < 0)
  32. {
  33. return policies::raise_domain_error<T>(function, "Argument x must be >= 0, but got %1%", x, pol);
  34. }
  35. if(y < 0)
  36. {
  37. return policies::raise_domain_error<T>(function, "Argument y must be >= 0, but got %1%", y, pol);
  38. }
  39. if(z <= 0)
  40. {
  41. return policies::raise_domain_error<T>(function, "Argument z must be > 0, but got %1%", z, pol);
  42. }
  43. if(x + y == 0)
  44. {
  45. return policies::raise_domain_error<T>(function, "At most one argument can be zero, but got, x + y = %1%", x + y, pol);
  46. }
  47. //
  48. // Special cases from http://dlmf.nist.gov/19.20#iv
  49. //
  50. if(x == z)
  51. {
  52. BOOST_MATH_GPU_SAFE_SWAP(x, y);
  53. }
  54. if(y == z)
  55. {
  56. if(x == y)
  57. {
  58. return 1 / (x * sqrt(x));
  59. }
  60. else if(x == 0)
  61. {
  62. return 3 * constants::pi<T>() / (4 * y * sqrt(y));
  63. }
  64. else
  65. {
  66. if(BOOST_MATH_GPU_SAFE_MAX(x, y) / BOOST_MATH_GPU_SAFE_MIN(x, y) > T(1.3))
  67. return 3 * (ellint_rc_imp(x, y, pol) - sqrt(x) / y) / (2 * (y - x));
  68. // Otherwise fall through to avoid cancellation in the above (RC(x,y) -> 1/x^0.5 as x -> y)
  69. }
  70. }
  71. if(x == y)
  72. {
  73. if(BOOST_MATH_GPU_SAFE_MAX(x, z) / BOOST_MATH_GPU_SAFE_MIN(x, z) > T(1.3))
  74. return 3 * (ellint_rc_imp(z, x, pol) - 1 / sqrt(z)) / (z - x);
  75. // Otherwise fall through to avoid cancellation in the above (RC(x,y) -> 1/x^0.5 as x -> y)
  76. }
  77. if(y == 0)
  78. {
  79. BOOST_MATH_GPU_SAFE_SWAP(x, y);
  80. }
  81. if(x == 0)
  82. {
  83. //
  84. // Special handling for common case, from
  85. // Numerical Computation of Real or Complex Elliptic Integrals, eq.47
  86. //
  87. T xn = sqrt(y);
  88. T yn = sqrt(z);
  89. T x0 = xn;
  90. T y0 = yn;
  91. T sum = 0;
  92. T sum_pow = 0.25f;
  93. while(fabs(xn - yn) >= T(2.7) * tools::root_epsilon<T>() * fabs(xn))
  94. {
  95. T t = sqrt(xn * yn);
  96. xn = (xn + yn) / 2;
  97. yn = t;
  98. sum_pow *= 2;
  99. const auto temp = (xn - yn);
  100. sum += sum_pow * temp * temp;
  101. }
  102. T RF = constants::pi<T>() / (xn + yn);
  103. //
  104. // This following calculation suffers from serious cancellation when y ~ z
  105. // unless we combine terms. We have:
  106. //
  107. // ( ((x0 + y0)/2)^2 - z ) / (z(y-z))
  108. //
  109. // Substituting y = x0^2 and z = y0^2 and simplifying we get the following:
  110. //
  111. T pt = (x0 + 3 * y0) / (4 * z * (x0 + y0));
  112. //
  113. // Since we've moved the denominator from eq.47 inside the expression, we
  114. // need to also scale "sum" by the same value:
  115. //
  116. pt -= sum / (z * (y - z));
  117. return pt * RF * 3;
  118. }
  119. T xn = x;
  120. T yn = y;
  121. T zn = z;
  122. T An = (x + y + 3 * z) / 5;
  123. T A0 = An;
  124. // This has an extra 1.2 fudge factor which is really only needed when x, y and z are close in magnitude:
  125. T Q = pow(tools::epsilon<T>() / 4, -T(1) / 8) * BOOST_MATH_GPU_SAFE_MAX(BOOST_MATH_GPU_SAFE_MAX(An - x, An - y), An - z) * 1.2f;
  126. BOOST_MATH_INSTRUMENT_VARIABLE(Q);
  127. T lambda, rx, ry, rz;
  128. unsigned k = 0;
  129. T fn = 1;
  130. T RD_sum = 0;
  131. for(; k < policies::get_max_series_iterations<Policy>(); ++k)
  132. {
  133. rx = sqrt(xn);
  134. ry = sqrt(yn);
  135. rz = sqrt(zn);
  136. lambda = rx * ry + rx * rz + ry * rz;
  137. RD_sum += fn / (rz * (zn + lambda));
  138. An = (An + lambda) / 4;
  139. xn = (xn + lambda) / 4;
  140. yn = (yn + lambda) / 4;
  141. zn = (zn + lambda) / 4;
  142. fn /= 4;
  143. Q /= 4;
  144. BOOST_MATH_INSTRUMENT_VARIABLE(k);
  145. BOOST_MATH_INSTRUMENT_VARIABLE(RD_sum);
  146. BOOST_MATH_INSTRUMENT_VARIABLE(Q);
  147. if(Q < An)
  148. break;
  149. }
  150. policies::check_series_iterations<T, Policy>(function, k, pol);
  151. T X = fn * (A0 - x) / An;
  152. T Y = fn * (A0 - y) / An;
  153. T Z = -(X + Y) / 3;
  154. T E2 = X * Y - 6 * Z * Z;
  155. T E3 = (3 * X * Y - 8 * Z * Z) * Z;
  156. T E4 = 3 * (X * Y - Z * Z) * Z * Z;
  157. T E5 = X * Y * Z * Z * Z;
  158. T result = fn * pow(An, T(-3) / 2) *
  159. (1 - 3 * E2 / 14 + E3 / 6 + 9 * E2 * E2 / 88 - 3 * E4 / 22 - 9 * E2 * E3 / 52 + 3 * E5 / 26 - E2 * E2 * E2 / 16
  160. + 3 * E3 * E3 / 40 + 3 * E2 * E4 / 20 + 45 * E2 * E2 * E3 / 272 - 9 * (E3 * E4 + E2 * E5) / 68);
  161. BOOST_MATH_INSTRUMENT_VARIABLE(result);
  162. result += 3 * RD_sum;
  163. return result;
  164. }
  165. } // namespace detail
  166. template <class T1, class T2, class T3, class Policy>
  167. BOOST_MATH_GPU_ENABLED inline typename tools::promote_args<T1, T2, T3>::type
  168. ellint_rd(T1 x, T2 y, T3 z, const Policy& pol)
  169. {
  170. typedef typename tools::promote_args<T1, T2, T3>::type result_type;
  171. typedef typename policies::evaluation<result_type, Policy>::type value_type;
  172. return policies::checked_narrowing_cast<result_type, Policy>(
  173. detail::ellint_rd_imp(
  174. static_cast<value_type>(x),
  175. static_cast<value_type>(y),
  176. static_cast<value_type>(z), pol), "boost::math::ellint_rd<%1%>(%1%,%1%,%1%)");
  177. }
  178. template <class T1, class T2, class T3>
  179. BOOST_MATH_GPU_ENABLED inline typename tools::promote_args<T1, T2, T3>::type
  180. ellint_rd(T1 x, T2 y, T3 z)
  181. {
  182. return ellint_rd(x, y, z, policies::policy<>());
  183. }
  184. }} // namespaces
  185. #endif // BOOST_MATH_ELLINT_RD_HPP