s21bd returns a value of the symmetrised elliptic integral of the third kind.
Syntax
C# |
---|
public static double s21bd( double x, double y, double z, double r, out int ifail ) |
Visual Basic |
---|
Public Shared Function s21bd ( _ x As Double, _ y As Double, _ z As Double, _ r As Double, _ <OutAttribute> ByRef ifail As Integer _ ) As Double |
Visual C++ |
---|
public: static double s21bd( double x, double y, double z, double r, [OutAttribute] int% ifail ) |
F# |
---|
static member s21bd : x : float * y : float * z : float * r : float * ifail : int byref -> float |
Parameters
- x
- Type: System..::..DoubleOn entry: the arguments , , and of the function.
- y
- Type: System..::..DoubleOn entry: the arguments , , and of the function.
- z
- Type: System..::..DoubleOn entry: the arguments , , and of the function.
- r
- Type: System..::..DoubleOn entry: the arguments , , and of the function.
- ifail
- Type: System..::..Int32%On exit: unless the method detects an error or a warning has been flagged (see [Error Indicators and Warnings]).
Return Value
s21bd returns a value of the symmetrised elliptic integral of the third kind.
Description
s21bd calculates an approximation to the integral
where , , , and at most one of , and is zero.
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 rule:
For sufficiently large,
and the function may be approximated by a fifth order power series
where .
The truncation error in this expansion is bounded by and the recursion process is terminated when this quantity is negligible compared with the machine precision. The method may fail either because it has been called with arguments outside the domain of definition or with arguments so extreme that there is an unavoidable danger of setting underflow or overflow.
Note: , so there exists a region of extreme arguments for which the function value is not representable.
References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
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
Error Indicators and Warnings
Errors or warnings detected by the method:
- ; the function is undefined.
- On entry, either r is too close to zero, or any two of x, y and z are too close to zero; there is a danger of setting overflow. See also the Users' Note for your implementation.
- On entry, at least one of x, y, z and r is too large; there is a danger of setting underflow. See also the Users' Note for your implementation.
Accuracy
In principle the method is capable of producing full machine precision. However round-off errors in internal arithmetic will result in slight loss of accuracy. This loss should never be excessive as the algorithm does not involve any significant amplification of round-off error. It is reasonable to assume that the result is accurate to within a small multiple of the machine precision.
Parallelism and Performance
None.
Further Comments
You should consult (S not in this release) which shows the relationship of this function to the classical definitions of the elliptic integrals.
Example
This example simply generates a small set of nonextreme arguments which are used with the method to produce the table of low accuracy results.