NAG Library Function Document
nag_kelvin_kei_vector (s19arc)
1 Purpose
nag_kelvin_kei_vector (s19arc) returns an array of values for the Kelvin function .
2 Specification
#include <nag.h> |
#include <nags.h> |
void |
nag_kelvin_kei_vector (Integer n,
const double x[],
double f[],
Integer ivalid[],
NagError *fail) |
|
3 Description
nag_kelvin_kei_vector (s19arc) evaluates an approximation to the Kelvin function for an array of arguments , for .
Note: for the function is undefined, so we need only consider .
The function is based on several Chebyshev expansions:
For
,
where
,
and
are expansions in the variable
;
For
,
where
is an expansion in the variable
;
For
,
where
, and
and
are expansions in the variable
.
For , the function is undefined, and hence the function fails and returns zero.
When
is sufficiently close to zero, the result is computed as
and when
is even closer to zero simply as
For large
,
is asymptotically given by
and this becomes so small that it cannot be computed without underflow and the function fails.
4 References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
5 Arguments
- 1:
n – IntegerInput
On entry: , the number of points.
Constraint:
.
- 2:
x[n] – const doubleInput
On entry: the argument of the function, for .
Constraint:
, for .
- 3:
f[n] – doubleOutput
On exit: , the function values.
- 4:
ivalid[n] – IntegerOutput
On exit:
contains the error code for
, for
.
- No error.
- is too large, the result underflows. contains zero. The threshold value is the same as for NE_REAL_ARG_GT in nag_kelvin_kei (s19adc), as defined in the Users' Note for your implementation.
- , the function is undefined. contains .
- 5:
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.
- NW_IVALID
-
On entry, at least one value of
x was invalid.
Check
ivalid for more information.
7 Accuracy
Let
be the absolute error in the result, and
be the relative error in the argument. If
is somewhat larger than the machine representation error, then we have:
For small
, errors are attenuated by the function and hence are limited by the
machine precision.
For medium and large , the error behaviour, like the function itself, is oscillatory and hence only absolute accuracy of the function can be maintained. For this range of , the amplitude of the absolute error decays like , which implies a strong attenuation of error. Eventually, , which is asymptotically given by , becomes so small that it cannot be calculated without causing underflow and therefore the function returns zero. Note that for large , the errors are dominated by those of the standard function exp.
8 Parallelism and Performance
Not applicable.
Underflow may occur for a few values of
close to the zeros of
, below the limit which causes a failure with
NW_IVALID.
10 Example
This example reads values of
x from a file, evaluates the function at each value of
and prints the results.
10.1 Program Text
Program Text (s19arce.c)
10.2 Program Data
Program Data (s19arce.d)
10.3 Program Results
Program Results (s19arce.r)