NAG FL Interface
s17dlf (hankel_​complex)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

s17dlf returns a sequence of values for the Hankel functions Hν+n (1) (z) or Hν+n (2) (z) for complex z, non-negative ν and n=0,1,,N-1, with an option for exponential scaling.

2 Specification

Fortran Interface
Subroutine s17dlf ( m, fnu, z, n, scal, cy, nz, ifail)
Integer, Intent (In) :: m, n
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: nz
Real (Kind=nag_wp), Intent (In) :: fnu
Complex (Kind=nag_wp), Intent (In) :: z
Complex (Kind=nag_wp), Intent (Out) :: cy(n)
Character (1), Intent (In) :: scal
C Header Interface
#include <nag.h>
void  s17dlf_ (const Integer *m, const double *fnu, const Complex *z, const Integer *n, const char *scal, Complex cy[], Integer *nz, Integer *ifail, const Charlen length_scal)
The routine may be called by the names s17dlf or nagf_specfun_hankel_complex.

3 Description

s17dlf evaluates a sequence of values for the Hankel function Hν (1) (z) or Hν (2) (z), where z is complex, -π<argzπ, and ν is the real, non-negative order. The N-member sequence is generated for orders ν, ν+1,,ν+N-1. Optionally, the sequence is scaled by the factor e-iz if the function is Hν (1) (z) or by the factor eiz if the function is Hν (2) (z).
Note:  although the routine may not be called with ν less than zero, for negative orders the formulae H-ν (1) (z)=eνπiHν (1) (z), and H-ν (2) (z)=e-νπiHν (2) (z) may be used.
The routine is derived from the routine CBESH in Amos (1986). It is based on the relation
Hν (m) (z)=1pe-pνKν(ze-p),  
where p= iπ2 if m=1 and p=- iπ2 if m=2, and the Bessel function Kν(z) is computed in the right half-plane only. Continuation of Kν(z) to the left half-plane is computed in terms of the Bessel function Iν(z). These functions are evaluated using a variety of different techniques, depending on the region under consideration.
When N is greater than 1, extra values of Hν (m) (z) are computed using recurrence relations.
For very large |z| or (ν+N-1), argument reduction will cause total loss of accuracy, and so no computation is performed. For slightly smaller |z| or (ν+N-1), the computation is performed but results are accurate to less than half of machine precision. If |z| is very small, near the machine underflow threshold, or (ν+N-1) is too large, there is a risk of overflow and so no computation is performed. In all the above cases, a warning is given by the routine.

4 References

NIST Digital Library of Mathematical Functions
Amos D E (1986) Algorithm 644: A portable package for Bessel functions of a complex argument and non-negative order ACM Trans. Math. Software 12 265–273

5 Arguments

1: m Integer Input
On entry: the kind of functions required.
The functions are Hν (1) (z).
The functions are Hν (2) (z).
Constraint: m=1 or 2.
2: fnu Real (Kind=nag_wp) Input
On entry: ν, the order of the first member of the sequence of functions.
Constraint: fnu0.0.
3: z Complex (Kind=nag_wp) Input
On entry: the argument z of the functions.
Constraint: z(0.0,0.0).
4: n Integer Input
On entry: N, the number of members required in the sequence Hν (m) (z),Hν+1 (m) (z),,Hν+N-1 (m) (z).
Constraint: n1.
5: scal Character(1) Input
On entry: the scaling option.
The results are returned unscaled.
The results are returned scaled by the factor e-iz when m=1, or by the factor eiz when m=2.
Constraint: scal='U' or 'S'.
6: cy(n) Complex (Kind=nag_wp) array Output
On exit: the N required function values: cy(i) contains H ν+i-1 (m) (z) , for i=1,2,,N.
7: nz Integer Output
On exit: the number of components of cy that are set to zero due to underflow. If nz>0, then if Im(z)>0.0 and m=1, or Im(z)<0.0 and m=2, elements cy(1),cy(2),,cy(nz) are set to zero. In the complementary half-planes, nz simply states the number of underflows, and not which elements they are.
8: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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).

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, fnu=value.
Constraint: fnu0.0.
On entry, m has illegal value: m=value.
On entry, n=value.
Constraint: n1.
On entry, scal has an illegal value: scal=value.
On entry, z=(0.0,0.0).
No computation because |z|=value<value.
No computation because fnu+n-1=value is too large.
Results lack precision, fnu+n-1=value>value.
Results lack precision because |z|=value>value.
No computation because |z|=value>value.
No computation because fnu+n-1=value>value.
No computation – algorithm termination condition not met.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

All constants in s17dlf are given to approximately 18 digits of precision. Calling the number of digits of precision in the floating-point arithmetic being used t, then clearly the maximum number of correct digits in the results obtained is limited by p=min(t,18). Because of errors in argument reduction when computing elementary functions inside s17dlf, the actual number of correct digits is limited, in general, by p-s, where s max(1,|log10|z||,|log10ν|) represents the number of digits lost due to the argument reduction. Thus the larger the values of |z| and ν, the less the precision in the result. If s17dlf is called with n>1, then computation of function values via recurrence may lead to some further small loss of accuracy.
If function values which should nominally be identical are computed by calls to s17dlf with different base values of ν and different n, the computed values may not agree exactly. Empirical tests with modest values of ν and z have shown that the discrepancy is limited to the least significant 34 digits of precision.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
s17dlf is not threaded in any implementation.

9 Further Comments

The time taken for a call of s17dlf is approximately proportional to the value of n, plus a constant. In general it is much cheaper to call s17dlf with n greater than 1, rather than to make N separate calls to s17dlf.
Paradoxically, for some values of z and ν, it is cheaper to call s17dlf with a larger value of n than is required, and then discard the extra function values returned. However, it is not possible to state the precise circumstances in which this is likely to occur. It is due to the fact that the base value used to start recurrence may be calculated in different regions for different n, and the costs in each region may differ greatly.

10 Example

This example prints a caption and then proceeds to read sets of data from the input data stream. The first datum is a value for the kind of function, m, the second is a value for the order fnu, the third is a complex value for the argument, z, and the fourth is a character value to set the argument scal. The program calls the routine with n=2 to evaluate the function for orders fnu and fnu+1, and it prints the results. The process is repeated until the end of the input data stream is encountered.

10.1 Program Text

Program Text (s17dlfe.f90)

10.2 Program Data

Program Data (s17dlfe.d)

10.3 Program Results

Program Results (s17dlfe.r)