Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	ivalid(n)
Real (Kind=nag_wp), Intent (In)	::	x(n)
Real (Kind=nag_wp), Intent (Out)	::	f(n)

C Header Interface

#include <nag.h>

void	s18asf_ (const Integer n, const double x[], double f[], Integer ivalid[], Integer ifail)

The routine may be called by the names s18asf or nagf_specfun_bessel_i0_real_vector.

3 Description

s18asf evaluates an approximation to the modified Bessel function of the first kind

I_{0} (x_{i})

for an array of arguments

x_{i}

, for

i = 1, 2, \dots, n

Note:

I_{0} (- x) = I_{0} (x)

, so the approximation need only consider

x \geq 0

The routine is based on three Chebyshev expansions:

For

0 < x \leq 4

I_{0} (x) = e^{x} \underset{r = 0}{\sum^{'}} a_{r} T_{r} (t),   where ​ t = 2 (\frac{x}{4}) - 1 .

For

4 < x \leq 12

I_{0} (x) = e^{x} \underset{r = 0}{\sum^{'}} b_{r} T_{r} (t),   where ​ t = \frac{x - 8}{4} .

For

x > 12

I_{0} (x) = \frac{e^{x}}{\sqrt{x}} \underset{r = 0}{\sum^{'}} c_{r} T_{r} (t),   where ​ t = 2 (\frac{12}{x}) - 1 .

For small

x

I_{0} (x) ≃ 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

NIST Digital Library of Mathematical Functions

5 Arguments

1: $n$ – Integer Input

On entry:

n

, the number of points.

Constraint:

n \geq 0

2: $x (n)$ – Real (Kind=nag_wp) array Input

On entry: the argument

x_{i}

of the function, for

i = 1, 2, \dots, n

3: $f (n)$ – Real (Kind=nag_wp) array Output

On exit:

I_{0} (x_{i})

, the function values.

4: $ivalid (n)$ – Integer array Output

On exit:

ivalid (i)

contains the error code for

x_{i}

, for

i = 1, 2, \dots, n

$ivalid (i) = 0$: No error.
$ivalid (i) = 1$: $x_{i}$ is too large. $f (i)$ contains the approximate value of $I_{0} (x_{i})$ at the nearest valid argument. The threshold value is the same as for $ifail = 1$ in s18aef , as defined in the Users' Note for your implementation.

5: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

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

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

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, at least one value of x was invalid.
Check ivalid for more information.

$ifail = 2$: On entry, $n = ⟨ value ⟩$ .
Constraint: $n \geq 0$ .

$ifail = - 99$: 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.

$ifail = - 399$: 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.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Let

δ

and

ε

be the relative errors in the argument and result respectively.

δ

is somewhat larger than the machine precision (i.e., if

δ

is due to data errors etc.), then

ε

and

δ

are approximately related by:

ε ≃ | \frac{x I_{1} (x)}{I_{0} (x)} | δ .

Figure 1 shows the behaviour of the error amplification factor

| \frac{x I_{1} (x)}{I_{0} (x)} | .

Figure 1

However, if

δ

is of the same order as machine precision, then rounding errors could make

ε

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

ε

can never be less than the machine precision.

For large

x

ε ≃ x δ

and we have strong amplification of errors. However, for quite moderate values of

x

(

x > \hat{x}

, the threshold value), the routine must fail because

I_{0} (x)

would overflow; hence in practice the loss of accuracy for

x

close to

\hat{x}

is not excessive and the errors will be dominated by those of the standard function exp.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

s18asf is not threaded in any implementation.

9 Further Comments

None.

10 Example

This example reads values of x from a file, evaluates the function at each value of

x_{i}

and prints the results.

s18as: FL CL CPP AD PY MB

NAG FL Interfaces18asf (bessel_​i0_​real_​vector)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
s18asf (bessel_i0_real_vector)