NAG Library Routine Document
s21bbf (ellipint_symm_1)
1
Purpose
s21bbf returns a value of the symmetrised elliptic integral of the first kind, via the function name.
2
Specification
Fortran Interface
Real (Kind=nag_wp)  ::  s21bbf  Integer, Intent (Inout)  ::  ifail  Real (Kind=nag_wp), Intent (In)  ::  x, y, z 

C Header Interface
#include nagmk26.h
double 
s21bbf_ (const double *x, const double *y, const double *z, Integer *ifail) 

3
Description
s21bbf calculates an approximation to the integral
where
$x$,
$y$,
$z\ge 0$ 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:
 ${x}_{0}=\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left(x,y,z\right)$, $\text{\hspace{1em}}{z}_{0}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(x,y,z\right)$,
 ${y}_{0}=\text{}$ remaining third intermediate value argument.
(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.)
${\epsilon}_{n}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(\left{X}_{n}\right,\left{Y}_{n}\right,\left{Z}_{n}\right\right)$ and the function may be approximated adequately by a fifth order power series:
where
${E}_{2}={X}_{n}{Y}_{n}+{Y}_{n}{Z}_{n}+{Z}_{n}{X}_{n}$,
${E}_{3}={X}_{n}{Y}_{n}{Z}_{n}$.
The truncation error involved in using this approximation is bounded by ${\epsilon}_{n}^{6}/4\left(1{\epsilon}_{n}\right)$ 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
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
5
Arguments
 1: $\mathbf{x}$ – Real (Kind=nag_wp)Input
 2: $\mathbf{y}$ – Real (Kind=nag_wp)Input
 3: $\mathbf{z}$ – Real (Kind=nag_wp)Input

On entry: the arguments $x$, $y$ and $z$ of the function.
Constraint:
${\mathbf{x}}$,
y,
${\mathbf{z}}\ge 0.0$ and only one of
x,
y and
z may be zero.
 4: $\mathbf{ifail}$ – IntegerInput/Output

On entry:
ifail must be set to
$0$,
$1\text{ or}1$. If you are unfamiliar with this argument you should refer to
Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value
$1\text{ or}1$ is recommended. If the output of error messages is undesirable, then the value
$1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
$0$.
When the value $\mathbf{1}\text{ or}\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit:
${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
${\mathbf{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:
 ${\mathbf{ifail}}=1$

On entry, one or more of
x,
y and
z is negative; the function is undefined.
 ${\mathbf{ifail}}=2$

On entry, two or more of
x,
y and
z are zero; the function is undefined. On soft failure, the routine returns zero.
 ${\mathbf{ifail}}=99$
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.9 in How to Use the NAG Library and its Documentation for further information.
 ${\mathbf{ifail}}=399$
Your licence key may have expired or may not have been installed correctly.
See
Section 3.8 in How to Use the NAG Library and its Documentation for further information.
 ${\mathbf{ifail}}=999$
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
In principle s21bbf is capable of producing full machine precision. However roundoff 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 roundoff error. It is reasonable to assume that the result is accurate to within a small multiple of the machine precision.
8
Parallelism and Performance
s21bbf is not threaded in any implementation.
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
${R}_{C}$, 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)