NAG Library Routine Document

s21cbf (jacellip_complex)


s21cbf evaluates the Jacobian elliptic functions snz, cnz and dnz for a complex argument z.


Fortran Interface
Subroutine s21cbf ( z, ak2, sn, cn, dn, ifail)
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (In):: ak2
Complex (Kind=nag_wp), Intent (In):: z
Complex (Kind=nag_wp), Intent (Out):: sn, cn, dn
C Header Interface
#include <nagmk26.h>
void  s21cbf_ (const Complex *z, const double *ak2, Complex *sn, Complex *cn, Complex *dn, Integer *ifail)


s21cbf evaluates the Jacobian elliptic functions snzk, cnzk and dnzk given by
snzk = sinϕ cnzk = cosϕ dnzk = 1-k2sin2ϕ,  
where z is a complex argument, k is a real argument (the modulus) with k21 and ϕ (the amplitude of z) is defined by the integral
z=0ϕdθ 1-k2sin2θ .  
The above definitions can be extended for values of k2>1 (see Salzer (1962)) by means of the formulae
snzk = k1snkzk1 cnzk = dnkzk1 dnzk = cnkzk1,  
where k1=1/k.
Special values include
snz0 = sinz cnz0 = cosz dnz0 = 1 snz1 = tanhz cnz1 = sechz dnz1 = sechz.  
These functions are often simply written as snz, cnz and dnz, thereby avoiding explicit reference to the argument k. They can also be expressed in terms of Jacobian theta functions (see s21ccf).
Another nine elliptic functions may be computed via the formulae
cdz = cnz/dnz sdz = snz/dnz ndz = 1/dnz dcz = dnz/cnz ncz = 1/cnz scz = snz/cnz nsz = 1/snz dsz = dnz/snz csz = cnz/snz  
(see Abramowitz and Stegun (1972)).
The values of snz, cnz and dnz are obtained by calls to s21caf. Further details can be found in Section 9.


Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Salzer H E (1962) Quick calculation of Jacobian elliptic functions Comm. ACM 5 399


1:     z – Complex (Kind=nag_wp)Input
On entry: the argument z of the functions.
  • absRe(z)=λ;
  • absIm(z)λ, where λ=1/x02amf.
2:     ak2 – Real (Kind=nag_wp)Input
On entry: the value of k2.
Constraint: 0.0ak21.0.
3:     sn – Complex (Kind=nag_wp)Output
4:     cn – Complex (Kind=nag_wp)Output
5:     dn – Complex (Kind=nag_wp)Output
On exit: the values of the functions snz, cnz and dnz, respectively.
6:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 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 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 -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

Error Indicators and Warnings

If on entry 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:
On entry, Im(z) is too large: Im(z)=value. It must be less than value.
On entry, Re(z) is too large: Re(z)=value. It must be less than value.
On entry, ak2=value.
Constraint: ak21.0.
On entry, ak2=value.
Constraint: ak20.0.
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.
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.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


In principle the routine is capable of achieving full relative precision in the computed values. However, the accuracy obtainable in practice depends on the accuracy of the standard elementary functions such as SIN and COS.

Parallelism and Performance

s21cbf is not threaded in any implementation.

Further Comments

The values of snz, cnz and dnz are computed via the formulae
snz = snu,kdnv,k 1-dn2u,ksn2v,k + i cnu,kdnu,ksnv,kcnv,k 1-dn2u,ksn2v,k cnz = cnu,kcnv,k 1-dn2u,ksn2v,k - i snu,kdnu,ksnv,kdnv,k 1-dn2u,ksn2v,k dnz = dnu,kcnv,kdnv,k 1-dn2u,ksn2v,k - i k2snu,kcnu,ksnv,k 1-dn2u,ksn2v,k ,  
where z=u+iv and k=1-k2 (the complementary modulus).


This example evaluates snz, cnz and dnz at z=-2.0+3.0i when k=0.5, and prints the results.

Program Text

Program Text (s21cbfe.f90)

Program Data

Program Data (s21cbfe.d)

Program Results

Program Results (s21cbfe.r)