hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_specfun_ellipint_symm_2 (s21bc)


    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example


nag_specfun_ellipint_symm_2 (s21bc) returns a value of the symmetrised elliptic integral of the second kind, via the function name.


[result, ifail] = s21bc(x, y, z)
[result, ifail] = nag_specfun_ellipint_symm_2(x, y, z)


nag_specfun_ellipint_symm_2 (s21bc) calculates an approximate value for the integral
RDx,y,z=320dt t+xt+y t+z 3  
where x, y0, at most one of x and y is zero, and z>0.
The basic algorithm, which is due to Carlson (1979) and Carlson (1988), is to reduce the arguments recursively towards their mean by the rule:
x0 = x,y0=y,z0=z μn = xn+yn+3zn/5 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  
For n sufficiently large,
εn=maxXn,Yn,Zn 14 n  
and the function may be approximated adequately by a fifth order power series
RDx,y,z= 3m= 0 n- 1 4-mzm+λnzm + 4-nμn3 1+ 37Sn 2 + 13Sn 3 + 322Sn 2 2+ 311Sn 4 + 313Sn 2 Sn 3 + 313Sn 5  
where Sn m =Xnm+Ynm+3Znm /2m. The truncation error in this expansion is bounded by 3εn6 1-εn 3  and the recursive process is terminated when this quantity is negligible compared with the machine precision.
The function 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:  RDx,x,x=x-3/2, so there exists a region of extreme arguments for which the function value is not representable.


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


Compulsory Input Parameters

1:     x – double scalar
2:     y – double scalar
3:     z – double scalar
The arguments x, y and z of the function.
Constraint: x, y0.0, z>0.0 and only one of x and y may be zero.

Optional Input Parameters


Output Parameters

1:     result – double scalar
The result of the function.
2:     ifail int64int32nag_int scalar
ifail=0 unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Errors or warnings detected by the function:
On entry, either x or y is negative, or both x and y are zero; the function is undefined.
On entry, z0.0; the function is undefined.
On entry, either z is too close to zero or both x and y are too close to zero: there is a danger of setting overflow.
On entry, at least one of x, y and z is too large: there is a danger of setting underflow. On soft failure the function returns zero.
An unexpected error has been triggered by this routine. Please contact NAG.
Your licence key may have expired or may not have been installed correctly.
Dynamic memory allocation failed.


In principle the function 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.

Further Comments

You should consult the S Chapter Introduction which shows the relationship of this function to the classical definitions of the elliptic integrals.


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

fprintf('s21bc example results\n\n');

x = [0.5   0.5   0.5   1    1   1.5];
y = [0.5   1.0   1.5   1    1.5   1.5];
z = [1     1     1     1    1   1];
result = x;

for j=1:numel(x)
  [result(j), ifail] = s21bc(x(j), y(j), z(j));

fprintf('    x      y      z      R_D(x,y,z)\n');
fprintf('%7.2f%7.2f%7.2f%12.4f\n',[x; y; z; result]);

s21bc example results

    x      y      z      R_D(x,y,z)
   0.50   0.50   1.00      1.4787
   0.50   1.00   1.00      1.2108
   0.50   1.50   1.00      1.0611
   1.00   1.00   1.00      1.0000
   1.00   1.50   1.00      0.8805
   1.50   1.50   1.00      0.7775

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015