s21be returns a value of the classical (Legendre) form of the incomplete elliptic integral of the first kind.

Syntax

C#
public static double s21be(
	double phi,
	double dm,
	out int ifail
)
Visual Basic
Public Shared Function s21be ( _
	phi As Double, _
	dm As Double, _
	<OutAttribute> ByRef ifail As Integer _
) As Double
Visual C++
public:
static double s21be(
	double phi, 
	double dm, 
	[OutAttribute] int% ifail
)
F#
static member s21be : 
        phi : float * 
        dm : float * 
        ifail : int byref -> float

Parameters

phi
Type: System..::..Double
On entry: the arguments ϕ and m of the function.
Constraints:
  • 0.0≤phi≤π2;
  • dm×sin2phi≤1.0;
  • Only one of sinphi and dm may be 1.0.
Note that dm×sin2phi=1.0 is allowable, as long as dm≠1.0.
dm
Type: System..::..Double
On entry: the arguments ϕ and m of the function.
Constraints:
  • 0.0≤phi≤π2;
  • dm×sin2phi≤1.0;
  • Only one of sinphi and dm may be 1.0.
Note that dm×sin2phi=1.0 is allowable, as long as dm≠1.0.
ifail
Type: System..::..Int32%
On exit: ifail=0 unless the method detects an error or a warning has been flagged (see [Error Indicators and Warnings]).

Return Value

s21be returns a value of the classical (Legendre) form of the incomplete elliptic integral of the first kind.

Description

s21be calculates an approximation to the integral
Fϕ∣m=∫0ϕ1-msin2 θ-12dθ,
where 0≤ϕ≤π2, msin2 ϕ≤1 and m and sin ϕ may not both equal one.
The integral is computed using the symmetrised elliptic integrals of Carlson (Carlson (1979) and Carlson (1988)). The relevant identity is
Fϕ∣m=RFq,r,1sin ϕ,
where q=cos2 ϕ, r=1-msin2 ϕ and RF is the Carlson symmetrised incomplete elliptic integral of the first kind (see s21bb).

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:
ifail=1
phi lies outside the range 0,π2. On failure, the method returns zero.
ifail=2
On entry, dm×sin2phi>1.0; the function is undefined. On failure, the method returns zero.
ifail=3
On entry, sinphi=1.0 and dm=1.0; the function is infinite. On failure, the method returns the largest machine number (see x02al).
ifail=-9000
An error occured, see message report.

Accuracy

In principle s21be 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 between this method 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 RF, see the method document for s21bb.
If you wish to input a value of phi outside the range allowed by this method you should refer to Section 17.4 of Abramowitz and Stegun (1972) for useful identities. For example, F-ϕ|m=-Fϕ|m and Fsπ±ϕ|m=2sKm±Fϕ|m where s is an integer and Km is the complete elliptic integral given by s21bh.
A parameter m>1 can be replaced by one less than unity using Fϕ|m=1mFθ|1m, sin θ=msin ϕ.

Example

This example simply generates a small set of nonextreme arguments that are used with the method to produce the table of results.

Example program (C#): s21bee.cs

Example program results: s21bee.r

See Also