NAG Library Routine Document

s18atf (bessel_i1_real_vector)

1
Purpose

s18atf returns an array of values for the modified Bessel function I1x.

2
Specification

Fortran Interface
Subroutine s18atf ( n, x, f, ivalid, ifail)
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 <nagmk26.h>
void  s18atf_ (const Integer *n, const double x[], double f[], Integer ivalid[], Integer *ifail)

3
Description

s18atf evaluates an approximation to the modified Bessel function of the first kind I1xi for an array of arguments xi, for i=1,2,,n.
Note:  I1-x=-I1x, so the approximation need only consider x0.
The routine is based on three Chebyshev expansions:
For 0<x4,
I1x=xr=0arTrt,   where ​t=2 x4 2-1;  
For 4<x12,
I1x=exr=0brTrt,   where ​t=x-84;  
For x>12,
I1x=exx r=0crTrt,   where ​t=2 12x -1.  
For small x, I1xx. 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 I1x cannot be represented without overflow.

4
References

NIST Digital Library of Mathematical Functions

5
Arguments

1:     n – IntegerInput
On entry: n, the number of points.
Constraint: n0.
2:     xn – Real (Kind=nag_wp) arrayInput
On entry: the argument xi of the function, for i=1,2,,n.
3:     fn – Real (Kind=nag_wp) arrayOutput
On exit: I1xi, the function values.
4:     ivalidn – Integer arrayOutput
On exit: ivalidi contains the error code for xi, for i=1,2,,n.
ivalidi=0
No error.
ivalidi=1
xi is too large. fi contains the approximate value of I1xi at the nearest valid argument. The threshold value is the same as for ifail=1 in s18aff, as defined in the Users' Note for your implementation.
5:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 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 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 -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:
ifail=1
On entry, at least one value of x was invalid.
Check ivalid for more information.
ifail=2
On entry, n=value.
Constraint: n0.
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.
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.
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 δ and ε be the relative errors in the argument and result respectively.
If δ is somewhat larger than the machine precision (i.e., if δ is due to data errors etc.), then ε and δ are approximately related by:
ε xI0x- I1x I1 x δ.  
Figure 1 shows the behaviour of the error amplification factor
xI0x - I1x I1x .  
Figure 1
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, εδ and there is no amplification of errors.
For large x, εxδ and we have strong amplification of errors. However, for quite moderate values of x (x>x^, the threshold value), the routine must fail because I1x would overflow; hence in practice the loss of accuracy for x close to x^ is not excessive and the errors will be dominated by those of the standard function exp.

8
Parallelism and Performance

s18atf 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 xi and prints the results.

10.1
Program Text

Program Text (s18atfe.f90)

10.2
Program Data

Program Data (s18atfe.d)

10.3
Program Results

Program Results (s18atfe.r)