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_1 (s21bb)


    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example


nag_specfun_ellipint_symm_1 (s21bb) returns a value of the symmetrised elliptic integral of the first kind, via the function name.


[result, ifail] = s21bb(x, y, z)
[result, ifail] = nag_specfun_ellipint_symm_1(x, y, z)


nag_specfun_ellipint_symm_1 (s21bb) calculates an approximation to the integral
RFx,y,z=120dt t+xt+yt+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=maxXn,Yn,Zn and the function may be approximated adequately by a fifth order power series:
RFx,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/41-ε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.


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, y, z0.0 and only one of x, y and z 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, one or more of x, y and z is negative; the function is undefined.
On entry, two or more of x, y and z are zero; the function is undefined. 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 nag_specfun_ellipint_symm_1 (s21bb) 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.
If two arguments are equal, the function reduces to the elementary integral RC, computed by nag_specfun_ellipint_symm_1_degen (s21ba).


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 s21bb_example

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

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

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

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

s21bb example results

    x      y      z      R_F(x,y,z)
   0.50   1.00   1.50      1.0281
   1.00   1.50   2.00      0.8260
   1.50   2.00   2.50      0.7116

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