NAG FL Interface
s17dhf (airy_​bi_​complex)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

s17dhf returns the value of the Airy function Bi(z) or its derivative Bi(z) for complex z, with an option for exponential scaling.

2 Specification

Fortran Interface
Subroutine s17dhf ( deriv, z, scal, bi, ifail)
Integer, Intent (Inout) :: ifail
Complex (Kind=nag_wp), Intent (In) :: z
Complex (Kind=nag_wp), Intent (Out) :: bi
Character (1), Intent (In) :: deriv, scal
C Header Interface
#include <nag.h>
void  s17dhf_ (const char *deriv, const Complex *z, const char *scal, Complex *bi, Integer *ifail, const Charlen length_deriv, const Charlen length_scal)
The routine may be called by the names s17dhf or nagf_specfun_airy_bi_complex.

3 Description

s17dhf returns a value for the Airy function Bi(z) or its derivative Bi(z), where z is complex, -π<argzπ. Optionally, the value is scaled by the factor e|Re(2zz/3)|.
The routine is derived from the routine CBIRY in Amos (1986). It is based on the relations Bi(z)= z3(I-1/3(w)+I1/3(w)), and Bi(z)= z3(I-2/3(w)+I2/3(w)), where Iν is the modified Bessel function and w=2zz/3.
For very large |z|, argument reduction will cause total loss of accuracy, and so no computation is performed. For slightly smaller |z|, the computation is performed but results are accurate to less than half of machine precision. If Re(z) is too large, and the unscaled function is required, 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: deriv Character(1) Input
On entry: specifies whether the function or its derivative is required.
Bi(z) is returned.
Bi(z) is returned.
Constraint: deriv='F' or 'D'.
2: z Complex (Kind=nag_wp) Input
On entry: the argument z of the function.
3: scal Character(1) Input
On entry: the scaling option.
The result is returned unscaled.
The result is returned scaled by the factor e|Re(2zz/3)|.
Constraint: scal='U' or 'S'.
4: bi Complex (Kind=nag_wp) Output
On exit: the required function or derivative value.
5: 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, deriv has an illegal value: deriv=value.
On entry, scal has an illegal value: scal=value.
No computation because Re(z)=value is too large when scal='U'.
Results lack precision because |z|=value>value.
No computation because |z|=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 s17dhf 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 s17dhf, the actual number of correct digits is limited, in general, by p-s, where s max(1,|log10|z||) represents the number of digits lost due to the argument reduction. Thus the larger the value of |z|, the less the precision in the result.
Empirical tests with modest values of z, checking relations between Airy functions Ai(z), Ai(z), Bi(z) and Bi(z), have shown errors limited to the least significant 34 digits of precision.

8 Parallelism and Performance

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

9 Further Comments

Note that if the function is required to operate on a real argument only, then it may be much cheaper to call s17ahf or s17akf.

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 argument deriv, the second is a complex value for the argument, z, and the third is a character value to set the argument scal. The program calls the routine and prints the results. The process is repeated until the end of the input data stream is encountered.

10.1 Program Text

Program Text (s17dhfe.f90)

10.2 Program Data

Program Data (s17dhfe.d)

10.3 Program Results

Program Results (s17dhfe.r)