naginterfaces.library.specfun.ellipint_symm_1_degen¶
- naginterfaces.library.specfun.ellipint_symm_1_degen(x, y)[source]¶
ellipint_symm_1_degen
returns a value of an elementary integral, which occurs as a degenerate case of an elliptic integral of the first kind.For full information please refer to the NAG Library document for s21ba
https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/s/s21baf.html
- Parameters
- xfloat
The argument of the function.
- yfloat
The argument of the function.
- Returns
- rcfloat
The value of an elementary integral, which occurs as a degenerate case of an elliptic integral of the first kind.
- Raises
- NagValueError
- (errno )
On entry, .
Constraint: .
The function is undefined.
- (errno )
On entry, .
Constraint: .
The function is undefined and returns zero.
- Notes
ellipint_symm_1_degen
calculates an approximate value for the integralwhere and .
This function, which is related to the logarithm or inverse hyperbolic functions for and to inverse circular functions if , arises as a degenerate form of the elliptic integral of the first kind. If , the result computed is the Cauchy principal value of the integral.
The basic algorithm, which is due to Carlson (1979) and Carlson (1988), is to reduce the arguments recursively towards their mean by the system:
The quantity for decreases with increasing , eventually . For small enough the required function value can be approximated by the first few terms of the Taylor series about the mean. That is
The truncation error involved in using this approximation is bounded by and the recursive process is stopped when is small enough for this truncation error to be negligible compared to the machine precision.
Within the domain of definition, the function value is itself representable for all representable values of its arguments. However, for values of the arguments near the extremes the above algorithm must be modified so as to avoid causing underflows or overflows in intermediate steps. In extreme regions arguments are prescaled away from the extremes and compensating scaling of the result is done before returning to the calling program.
- References
NIST Digital Library of Mathematical Functions
Carlson, B C, 1979, Computing elliptic integrals by duplication, Numerische Mathematik (33), 1–16
Carlson, B C, 1988, A table of elliptic integrals of the third kind, Math. Comput. (51), 267–280