NAG Library Routine Document
S21BHF returns a value of the classical (Legendre) form of the complete elliptic integral of the first kind, via the function name.
|REAL (KIND=nag_wp) S21BHF
S21BHF calculates an approximation to the integral
The integral is computed using the symmetrised elliptic integrals of Carlson (Carlson (1979)
and Carlson (1988)
). The relevant identity is
is the Carlson symmetrised incomplete elliptic integral of the first kind (see S21BBF
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
- 1: DM – REAL (KIND=nag_wp)Input
On entry: the argument of the function.
- 2: IFAIL – INTEGERInput/Output
must be set to
. If you are unfamiliar with this parameter you should refer to Section 3.3
in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
. When the value is used it is essential to test the value of IFAIL on exit.
unless the routine detects an error or a warning has been flagged (see Section 6
6 Error Indicators and Warnings
If on entry
, explanatory error messages are output on the current error message unit (as defined by X04AAF
Errors or warnings detected by the routine:
On entry, ; the function is undefined. On soft failure, the routine returns zero.
; the function is infinite. On soft failure, the routine returns the largest machine number (see X02ALF
In principle S21BHF 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.
You should consult the S Chapter Introduction
, which shows the relationship between this routine and the Carlson definitions of the elliptic integrals. In particular, the relationship between the argument-constraints for both forms becomes clear.
For more information on the algorithm used to compute
, see the routine document for S21BBF
This example simply generates a small set of nonextreme arguments that are used with the routine to produce the table of results.
9.1 Program Text
Program Text (s21bhfe.f90)
9.2 Program Data
9.3 Program Results
Program Results (s21bhfe.r)