NAG FL Interface
s17atf (bessel_​j1_​real_​vector)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

s17atf returns an array of values of the Bessel function J1(x).

2 Specification

Fortran Interface
Subroutine s17atf ( 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 <nag.h>
void  s17atf_ (const Integer *n, const double x[], double f[], Integer ivalid[], Integer *ifail)
The routine may be called by the names s17atf or nagf_specfun_bessel_j1_real_vector.

3 Description

s17atf evaluates an approximation to the Bessel function of the first kind J1(xi) for an array of arguments xi, for i=1,2,,n.
Note:  J1(-x)=-J1(x), so the approximation need only consider x0.
The routine is based on three Chebyshev expansions:
For 0<x8,
J1(x)=x8r=0arTr(t),   with ​t=2 (x8) 2-1.  
For x>8,
J1(x)=2πx {P1(x)cos(x-3π4)-Q1(x)sin(x-3π4)}  
where P1(x)=r=0brTr(t),
and Q1(x)= 8xr=0crTr(t),
with t=2 ( 8x) 2-1.
For x near zero, J1(x) x2 . This approximation is used when x is sufficiently small for the result to be correct to machine precision.
For very large x, it becomes impossible to provide results with any reasonable accuracy (see Section 7), hence the routine fails. Such arguments contain insufficient information to determine the phase of oscillation of J1(x); only the amplitude, 2π|x| , can be determined and this is returned on soft failure. The range for which this occurs is roughly related to machine precision; the routine will fail if |x|1/machine precision (see the Users' Note for your implementation for details).

4 References

NIST Digital Library of Mathematical Functions
Clenshaw C W (1962) Chebyshev Series for Mathematical Functions Mathematical tables HMSO

5 Arguments

1: n Integer Input
On entry: n, the number of points.
Constraint: n0.
2: x(n) Real (Kind=nag_wp) array Input
On entry: the argument xi of the function, for i=1,2,,n.
3: f(n) Real (Kind=nag_wp) array Output
On exit: J1(xi), the function values.
4: ivalid(n) Integer array Output
On exit: ivalid(i) contains the error code for xi, for i=1,2,,n.
ivalid(i)=0
No error.
ivalid(i)=1
On entry, xi is too large. f(i) contains the amplitude of the J1 oscillation, 2π|xi| .
5: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 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 or 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 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 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 δ be the relative error in the argument and E be the absolute error in the result. (Since J1(x) oscillates about zero, absolute error and not relative error is significant.)
If δ is somewhat larger than machine precision (e.g., if δ is due to data errors etc.), then E and δ are approximately related by:
E|xJ0(x)-J1(x)|δ  
(provided E is also within machine bounds). Figure 1 displays the behaviour of the amplification factor |xJ0(x)-J1(x)|.
However, if δ is of the same order as machine precision, then rounding errors could make E slightly larger than the above relation predicts.
For very large x, the above relation ceases to apply. In this region, J1(x) 2π|x| cos(x- 3π4). The amplitude 2π|x| can be calculated with reasonable accuracy for all x, but cos(x- 3π4) cannot. If x- 3π4 is written as 2Nπ+θ where N is an integer and 0θ<2π, then cos(x- 3π4) is determined by θ only. If xδ-1, θ cannot be determined with any accuracy at all. Thus if x is greater than, or of the order of, the reciprocal of machine precision, it is impossible to calculate the phase of J1(x) and the routine must fail.
Figure 1
Figure 1

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
s17atf 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 (s17atfe.f90)

10.2 Program Data

Program Data (s17atfe.d)

10.3 Program Results

Program Results (s17atfe.r)