NAG Library Function Document
nag_complex_bessel_i (s18dec)
1 Purpose
nag_complex_bessel_i (s18dec) returns a sequence of values for the modified Bessel functions for complex , non-negative
and , with an option for exponential scaling.
2 Specification
#include <nag.h> |
#include <nags.h> |
void |
nag_complex_bessel_i (double fnu,
Complex z,
Integer n,
Nag_ScaleResType scal,
Complex cy[],
Integer *nz,
NagError *fail) |
|
3 Description
nag_complex_bessel_i (s18dec) evaluates a sequence of values for the modified Bessel function , where is complex, , and is the real, non-negative order. The -member sequence is generated for orders . Optionally, the sequence is scaled by the factor .
The function is derived from the function CBESI in
Amos (1986).
Note: although the function may not be called with
less than zero, for negative orders the formula
may be used (for the Bessel function
, see
nag_complex_bessel_k (s18dcc)).
When is greater than , extra values of are computed using recurrence relations.
For very large or , argument reduction will cause total loss of accuracy, and so no computation is performed. For slightly smaller or , the computation is performed but results are accurate to less than half of machine precision. If is too large and the unscaled function is required, there is a risk of overflow and so no computation is performed. In all the above cases, a warning is given by the function.
4 References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Amos D E (1986) Algorithm 644: A portable package for Bessel functions of a complex argument and non-negative order ACM Trans. Math. Software 12 265–273
5 Arguments
- 1:
fnu – doubleInput
On entry: , the order of the first member of the sequence of functions.
Constraint:
.
- 2:
z – ComplexInput
On entry: the argument of the functions.
- 3:
n – IntegerInput
On entry: , the number of members required in the sequence .
Constraint:
.
- 4:
scal – Nag_ScaleResTypeInput
On entry: the scaling option.
- The results are returned unscaled.
- The results are returned scaled by the factor .
Constraint:
or .
- 5:
cy[n] – ComplexOutput
On exit: the required function values: contains
, for .
- 6:
nz – Integer *Output
On exit: the number of components of
cy that are set to zero due to underflow.
If , then elements are set to zero.
- 7:
fail – NagError *Input/Output
-
The NAG error argument (see
Section 3.6 in the Essential Introduction).
6 Error Indicators and Warnings
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_INT
-
On entry, .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
- NE_OVERFLOW_LIKELY
-
No computation because , .
- NE_REAL
-
On entry, .
Constraint: .
- NE_TERMINATION_FAILURE
-
No computation – algorithm termination condition not met.
- NE_TOTAL_PRECISION_LOSS
-
No computation because .
No computation because .
- NW_SOME_PRECISION_LOSS
-
Results lack precision because .
Results lack precision because .
7 Accuracy
All constants in nag_complex_bessel_i (s18dec) are given to approximately digits of precision. Calling the number of digits of precision in the floating-point arithmetic being used , then clearly the maximum number of correct digits in the results obtained is limited by . Because of errors in argument reduction when computing elementary functions inside nag_complex_bessel_i (s18dec), the actual number of correct digits is limited, in general, by , where represents the number of digits lost due to the argument reduction. Thus the larger the values of and , the less the precision in the result. If nag_complex_bessel_i (s18dec) is called with , then computation of function values via recurrence may lead to some further small loss of accuracy.
If function values which should nominally be identical are computed by calls to nag_complex_bessel_i (s18dec) with different base values of and different , the computed values may not agree exactly. Empirical tests with modest values of and have shown that the discrepancy is limited to the least significant – digits of precision.
8 Parallelism and Performance
Not applicable.
The time taken for a call of nag_complex_bessel_i (s18dec) is approximately proportional to the value of , plus a constant. In general it is much cheaper to call nag_complex_bessel_i (s18dec) with greater than , rather than to make separate calls to nag_complex_bessel_i (s18dec).
Paradoxically, for some values of and , it is cheaper to call nag_complex_bessel_i (s18dec) with a larger value of than is required, and then discard the extra function values returned. However, it is not possible to state the precise circumstances in which this is likely to occur. It is due to the fact that the base value used to start recurrence may be calculated in different regions for different , and the costs in each region may differ greatly.
Note that if the function required is
or
, i.e.,
or
, where
is real and positive, and only a single function value is required, then it may be much cheaper to call
nag_bessel_i0 (s18aec),
nag_bessel_i1 (s18afc),
nag_bessel_i0_scaled (s18cec) or
nag_bessel_i1_scaled (s18cfc), depending on whether a scaled result is required or not.
10 Example
This example prints a caption and then proceeds to read sets of data from the input data stream. The first datum is a value for the order
fnu, the second is a complex value for the argument,
z, and the third is a character value
used as a flag
to set the argument
scal. The program calls the function with
to evaluate the function for orders
fnu and
, and it prints the results. The process is repeated until the end of the input data stream is encountered.
10.1 Program Text
Program Text (s18dece.c)
10.2 Program Data
Program Data (s18dece.d)
10.3 Program Results
Program Results (s18dece.r)