NAG FL Interface
s21bbf (ellipint_​symm_​1)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

s21bbf returns a value of the symmetrised elliptic integral of the first kind, via the function name.

2 Specification

Fortran Interface
Function s21bbf ( x, y, z, ifail)
Real (Kind=nag_wp) :: s21bbf
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (In) :: x, y, z
C Header Interface
#include <nag.h>
double  s21bbf_ (const double *x, const double *y, const double *z, Integer *ifail)
The routine may be called by the names s21bbf or nagf_specfun_ellipint_symm_1.

3 Description

s21bbf calculates an approximation to the integral
RF(x,y,z)=120dt (t+x)(t+y)(t+z)  
where x, y, z0 and at most one is zero.
The basic algorithm, which is due to Carlson (1979) and Carlson (1988), is to reduce the arguments recursively towards their mean by the rule: (This ordering, which is possible because of the symmetry of the function, is done for technical reasons related to the avoidance of overflow and underflow.)
μn = (xn+yn+zn)/3 Xn = (1-xn)/μn Yn = (1-yn)/μn Zn = (1-zn)/μn λn = xnyn+ynzn+znxn xn+1 = (xn+λn)/4 yn+1 = (yn+λn)/4 zn+1 = (zn+λn)/4  
εn=max(|Xn|,|Yn|,|Zn|) and the function may be approximated adequately by a fifth order power series:
RF(x,y,z)=1μn (1-E210+E2224-3E2E344+E314)  
where E2=XnYn+YnZn+ZnXn, E3=XnYnZn.
The truncation error involved in using this approximation is bounded by εn6/4(1-εn) and the recursive process is stopped when this truncation error is negligible compared with 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.

4 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

5 Arguments

1: x Real (Kind=nag_wp) Input
2: y Real (Kind=nag_wp) Input
3: z Real (Kind=nag_wp) Input
On entry: the arguments x, y and z of the function.
Constraint: x, y, z0.0 and only one of x, y and z may be zero.
4: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry ifail=0 or −1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
On entry, x=value, y=value and z=value.
Constraint: x0.0 and y0.0 and z0.0.
The function is undefined.
ifail=2
On entry, x=value, y=value and z=value.
Constraint: at most one of x, y and z is 0.0.
The function is undefined and returns zero.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

In principle s21bbf 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.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
s21bbf is not threaded in any implementation.

9 Further Comments

You should consult the S Chapter Introduction which shows the relationship of this function to the classical definitions of the elliptic integrals.
If two arguments are equal, the function reduces to the elementary integral RC, computed by s21baf.

10 Example

This example simply generates a small set of nonextreme arguments which are used with the routine to produce the table of low accuracy results.

10.1 Program Text

Program Text (s21bbfe.f90)

10.2 Program Data

None.

10.3 Program Results

Program Results (s21bbfe.r)