NAG Library Routine Document
s18aff (bessel_i1_real)
1
Purpose
s18aff returns a value for the modified Bessel function ${I}_{1}\left(x\right)$, via the function name.
2
Specification
Fortran Interface
Real (Kind=nag_wp)  ::  s18aff  Integer, Intent (Inout)  ::  ifail  Real (Kind=nag_wp), Intent (In)  ::  x 

C Header Interface
#include nagmk26.h
double 
s18aff_ (const double *x, Integer *ifail) 

3
Description
s18aff evaluates an approximation to the modified Bessel function of the first kind ${I}_{1}\left(x\right)$.
Note: ${I}_{1}\left(x\right)={I}_{1}\left(x\right)$, so the approximation need only consider $x\ge 0$.
The routine is based on three Chebyshev expansions:
For
$0<x\le 4$,
For
$4<x\le 12$,
For
$x>12$,
For small
$x$,
${I}_{1}\left(x\right)\simeq x$. This approximation is used when
$x$ is sufficiently small for the result to be correct to
machine precision.
For large $x$, the routine must fail because ${I}_{1}\left(x\right)$ cannot be represented without overflow.
4
References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
5
Arguments
 1: $\mathbf{x}$ – Real (Kind=nag_wp)Input

On entry: the argument $x$ of the function.
 2: $\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$

x is too large. On soft failure the routine returns the approximate value of
${I}_{1}\left(x\right)$ at the nearest valid argument. See also the
Users' Note for your implementation.
 ${\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
Let $\delta $ and $\epsilon $ be the relative errors in the argument and result respectively.
If
$\delta $ is somewhat larger than the
machine precision (i.e., if
$\delta $ is due to data errors etc.), then
$\epsilon $ and
$\delta $ are approximately related by:
Figure 1 shows the behaviour of the error amplification factor
However, if $\delta $ is of the same order as machine precision, then rounding errors could make $\epsilon $ slightly larger than the above relation predicts.
For small $x$, $\epsilon \simeq \delta $ and there is no amplification of errors.
For large $x$, $\epsilon \simeq x\delta $ and we have strong amplification of errors. However the routine must fail for quite moderate values of $x$ because ${I}_{1}\left(x\right)$ would overflow; hence in practice the loss of accuracy for large $x$ is not excessive. Note that for large $x$, the errors will be dominated by those of the standard function exp.
8
Parallelism and Performance
s18aff is not threaded in any implementation.
None.
10
Example
This example reads values of the argument $x$ from a file, evaluates the function at each value of $x$ and prints the results.
10.1
Program Text
Program Text (s18affe.f90)
10.2
Program Data
Program Data (s18affe.d)
10.3
Program Results
Program Results (s18affe.r)