NAG Library Routine Document
s18def (bessel_i_complex)
1
Purpose
s18def returns a sequence of values for the modified Bessel functions ${I}_{\nu +n}\left(z\right)$ for complex $z$, nonnegative
$\nu $ and $n=0,1,\dots ,N1$, with an option for exponential scaling.
2
Specification
Fortran Interface
Integer, Intent (In)  ::  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 nagmk26.h
void 
s18def_ (const double *fnu, const Complex *z, const Integer *n, const char *scal, Complex cy[], Integer *nz, Integer *ifail, const Charlen length_scal) 

3
Description
s18def evaluates a sequence of values for the modified Bessel function ${I}_{\nu}\left(z\right)$, where $z$ is complex, $\pi <\mathrm{arg}z\le \pi $, and $\nu $ is the real, nonnegative order. The $N$member sequence is generated for orders $\nu ,\nu +1,\dots ,\nu +N1$. Optionally, the sequence is scaled by the factor ${e}^{\left\mathrm{Re}\left(z\right)\right}$.
The routine is derived from the routine CBESI in
Amos (1986).
Note: although the routine may not be called with
$\nu $ less than zero, for negative orders the formula
${I}_{\nu}\left(z\right)={I}_{\nu}\left(z\right)+\frac{2}{\pi}\mathrm{sin}\left(\pi \nu \right){K}_{\nu}\left(z\right)$ may be used (for the Bessel function
${K}_{\nu}\left(z\right)$, see
s18dcf).
When $N$ is greater than $1$, extra values of ${I}_{\nu}\left(z\right)$ are computed using recurrence relations.
For very large $\leftz\right$ or $\left(\nu +N1\right)$, argument reduction will cause total loss of accuracy, and so no computation is performed. For slightly smaller $\leftz\right$ or $\left(\nu +N1\right)$, the computation is performed but results are accurate to less than half of machine precision. If $\mathrm{Re}\left(z\right)$ 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
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Amos D E (1986) Algorithm 644: A portable package for Bessel functions of a complex argument and nonnegative order ACM Trans. Math. Software 12 265–273
5
Arguments
 1: $\mathbf{fnu}$ – Real (Kind=nag_wp)Input

On entry: $\nu $, the order of the first member of the sequence of functions.
Constraint:
${\mathbf{fnu}}\ge 0.0$.
 2: $\mathbf{z}$ – Complex (Kind=nag_wp)Input

On entry: the argument $z$ of the functions.
 3: $\mathbf{n}$ – IntegerInput

On entry: $N$, the number of members required in the sequence ${I}_{\nu}\left(z\right),{I}_{\nu +1}\left(z\right),\dots ,{I}_{\nu +N1}\left(z\right)$.
Constraint:
${\mathbf{n}}\ge 1$.
 4: $\mathbf{scal}$ – Character(1)Input

On entry: the scaling option.
 ${\mathbf{scal}}=\text{'U'}$
 The results are returned unscaled.
 ${\mathbf{scal}}=\text{'S'}$
 The results are returned scaled by the factor ${e}^{\left\mathrm{Re}\left(z\right)\right}$.
Constraint:
${\mathbf{scal}}=\text{'U'}$ or $\text{'S'}$.
 5: $\mathbf{cy}\left({\mathbf{n}}\right)$ – Complex (Kind=nag_wp) arrayOutput

On exit: the $N$ required function values: ${\mathbf{cy}}\left(i\right)$ contains
${I}_{\nu +i1}\left(z\right)$, for $\mathit{i}=1,2,\dots ,N$.
 6: $\mathbf{nz}$ – IntegerOutput

On exit: the number of components of
cy that are set to zero due to underflow.
If ${\mathbf{nz}}>0$, then elements ${\mathbf{cy}}\left({\mathbf{n}}{\mathbf{nz}}+1\right),{\mathbf{cy}}\left({\mathbf{n}}{\mathbf{nz}}+2\right),\dots ,{\mathbf{cy}}\left({\mathbf{n}}\right)$ are set to zero.
 7: $\mathbf{ifail}$ – IntegerInput/Output

On entry:
ifail must be set to
$0$,
$1\text{ 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\text{ 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 $\mathbf{1}\text{ or}\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit:
${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
${\mathbf{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:
 ${\mathbf{ifail}}=1$

On entry,  ${\mathbf{fnu}}<0.0$, 
or  ${\mathbf{n}}<1$, 
or  ${\mathbf{scal}}\ne \text{'U'}$ or $\text{'S'}$. 
 ${\mathbf{ifail}}=2$

No computation has been performed due to the likelihood of overflow, because real(
z) is greater than a machinedependent threshold value (given in the
Users' Note for your implementation). This error exit can only occur when
${\mathbf{scal}}=\text{'U'}$.
 ${\mathbf{ifail}}=3$

The computation has been performed, but the errors due to argument reduction in elementary functions make it likely that the results returned by
s18def are accurate to less than half of
machine precision. This error exit may occur when either
$\mathrm{abs}\left({\mathbf{z}}\right)$ or
${\mathbf{fnu}}+{\mathbf{n}}1$ is greater than a machinedependent threshold value (given in the
Users' Note for your implementation).
 ${\mathbf{ifail}}=4$

No computation has been performed because the errors due to argument reduction in elementary functions mean that all precision in results returned by
s18def would be lost. This error exit may occur when either
$\mathrm{abs}\left({\mathbf{z}}\right)$ or
${\mathbf{fnu}}+{\mathbf{n}}1$ is greater than a machinedependent threshold value (given in the
Users' Note for your implementation).
 ${\mathbf{ifail}}=5$

No results are returned because the algorithm termination condition has not been met. This may occur because the arguments supplied to s18def would have caused overflow or underflow.
 ${\mathbf{ifail}}=99$
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.
 ${\mathbf{ifail}}=399$
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.
 ${\mathbf{ifail}}=999$
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
All constants in s18def are given to approximately $18$ digits of precision. Calling the number of digits of precision in the floatingpoint arithmetic being used $t$, then clearly the maximum number of correct digits in the results obtained is limited by $p=\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left(t,18\right)$. Because of errors in argument reduction when computing elementary functions inside s18def, the actual number of correct digits is limited, in general, by $ps$, where $s\approx \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,\left{\mathrm{log}}_{10}\leftz\right\right,\left{\mathrm{log}}_{10}\nu \right\right)$ represents the number of digits lost due to the argument reduction. Thus the larger the values of $\leftz\right$ and $\nu $, the less the precision in the result. If s18def is called with ${\mathbf{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 s18def with different base values of $\nu $ and different ${\mathbf{n}}$, the computed values may not agree exactly. Empirical tests with modest values of $\nu $ and $z$ have shown that the discrepancy is limited to the least significant $3$ – $4$ digits of precision.
8
Parallelism and Performance
s18def is not threaded in any implementation.
The time taken for a call of s18def is approximately proportional to the value of ${\mathbf{n}}$, plus a constant. In general it is much cheaper to call s18def with ${\mathbf{n}}$ greater than $1$, rather than to make $N$ separate calls to s18def.
Paradoxically, for some values of $z$ and $\nu $, it is cheaper to call s18def with a larger value of ${\mathbf{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 ${\mathbf{n}}$, and the costs in each region may differ greatly.
Note that if the function required is
${I}_{0}\left(x\right)$ or
${I}_{1}\left(x\right)$, i.e.,
$\nu =0.0$ or
$1.0$, where
$x$ is real and positive, and only a single function value is required, then it may be much cheaper to call
s18aef,
s18aff,
s18cef or
s18cff, depending on whether a scaled result is required or not.
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 order
fnu, 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 with
${\mathbf{n}}=2$ to evaluate the function for orders
fnu and
${\mathbf{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 (s18defe.f90)
10.2
Program Data
Program Data (s18defe.d)
10.3
Program Results
Program Results (s18defe.r)