S18ASF (PDF version)
S Chapter Contents
S Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentS18ASF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

S18ASF returns an array of values of the modified Bessel function ${I}_{0}\left(x\right)$.

## 2  Specification

 SUBROUTINE S18ASF ( N, X, F, IVALID, IFAIL)
 INTEGER N, IVALID(N), IFAIL REAL (KIND=nag_wp) X(N), F(N)

## 3  Description

S18ASF evaluates an approximation to the modified Bessel function of the first kind ${I}_{0}\left({x}_{i}\right)$ for an array of arguments ${x}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$.
Note:  ${I}_{0}\left(-x\right)={I}_{0}\left(x\right)$, so the approximation need only consider $x\ge 0$.
The routine is based on three Chebyshev expansions:
For $0,
 $I0x=ex∑′r=0arTrt, where ​ t=2 x4 -1.$
For $4,
 $I0x=ex∑′r=0brTrt, where ​ t=x-84.$
For $x>12$,
 $I0x=exx ∑′r=0crTrt, where ​ t=2 12x -1.$
For small $x$, ${I}_{0}\left(x\right)\simeq 1$. 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 of the danger of overflow in calculating ${e}^{x}$.

## 4  References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications

## 5  Parameters

1:     N – INTEGERInput
On entry: $n$, the number of points.
Constraint: ${\mathbf{N}}\ge 0$.
2:     X(N) – REAL (KIND=nag_wp) arrayInput
On entry: the argument ${x}_{\mathit{i}}$ of the function, for $\mathit{i}=1,2,\dots ,{\mathbf{N}}$.
3:     F(N) – REAL (KIND=nag_wp) arrayOutput
On exit: ${I}_{0}\left({x}_{i}\right)$, the function values.
4:     IVALID(N) – INTEGER arrayOutput
On exit: ${\mathbf{IVALID}}\left(\mathit{i}\right)$ contains the error code for ${x}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{N}}$.
${\mathbf{IVALID}}\left(i\right)=0$
No error.
${\mathbf{IVALID}}\left(i\right)=1$
${x}_{i}$ is too large. ${\mathbf{F}}\left(\mathit{i}\right)$ contains the approximate value of ${I}_{0}\left({x}_{i}\right)$ at the nearest valid argument. The threshold value is the same as for ${\mathbf{IFAIL}}={\mathbf{1}}$ in S18AEF, as defined in the Users' Note for your implementation.
5:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction 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 parameter, 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}}={\mathbf{0}}$ or $-{\mathbf{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, at least one value of X was invalid.
Check IVALID for more information.
${\mathbf{IFAIL}}=2$
On entry, ${\mathbf{N}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{N}}\ge 0$.

## 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:
 $ε≃ x I1x I0 x δ.$
Figure 1 shows the behaviour of the error amplification factor
 $xI1x I0x .$
Figure 1
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$ the amplification factor is approximately $\frac{{x}^{2}}{2}$, which implies strong attenuation of the error, but in general $\epsilon$ can never be less than the machine precision.
For large $x$, $\epsilon \simeq x\delta$ and we have strong amplification of errors. However, for quite moderate values of $x$ ($x>\stackrel{^}{x}$, the threshold value), the routine must fail because ${I}_{0}\left(x\right)$ would overflow; hence in practice the loss of accuracy for $x$ close to $\stackrel{^}{x}$ is not excessive and the errors will be dominated by those of the standard function exp.

None.

## 9  Example

This example reads values of X from a file, evaluates the function at each value of ${x}_{i}$ and prints the results.

### 9.1  Program Text

Program Text (s18asfe.f90)

### 9.2  Program Data

Program Data (s18asfe.d)

### 9.3  Program Results

Program Results (s18asfe.r)

S18ASF (PDF version)
S Chapter Contents
S Chapter Introduction
NAG Library Manual