NAG Library Function Document
nag_polygamma_fun (s14acc)
1
Purpose
nag_polygamma_fun (s14acc) returns a value of the function , where is the psi function .
2
Specification
#include <nag.h> |
#include <nags.h> |
double |
nag_polygamma_fun (double x,
NagError *fail) |
|
3
Description
nag_polygamma_fun (s14acc) returns a value of the function . The psi function is computed without the logarithmic term so that when is large, sums or differences of psi functions may be computed without unnecessary loss of precision, by analytically combining the logarithmic terms. For example, the difference has an asymptotic behaviour for large given by .
Computing directly would amount to subtracting two large numbers which are close to and to produce a small number close to , resulting in a loss of significant digits. However, using this function to compute , we can compute , and the dominant logarithmic term may be computed accurately from its power series when is large. Thus we avoid the unnecessary loss of precision.
The function is derived from the function PSIFN in
Amos (1983).
4
References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Amos D E (1983) Algorithm 610: A portable FORTRAN subroutine for derivatives of the psi function ACM Trans. Math. Software 9 494–502
5
Arguments
- 1:
– doubleInput
-
On entry: the argument of the function.
Constraint:
.
- 2:
– NagError *Input/Output
-
The NAG error argument (see
Section 3.7 in How to Use the NAG Library and its Documentation).
6
Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
- 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.
See
Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
- NE_OVERFLOW_LIKELY
-
Computation halted due to likelihood of overflow.
x may be too small.
.
- NE_REAL
-
On entry, .
Constraint: .
- NE_UNDERFLOW_LIKELY
-
Computation halted due to likelihood of underflow.
x may be too large.
.
7
Accuracy
All constants in nag_polygamma_fun (s14acc) 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 .
With the above proviso, results returned by this function should be accurate almost to full precision, except at points close to the zero of , , where only absolute rather than relative accuracy can be obtained.
8
Parallelism and Performance
nag_polygamma_fun (s14acc) is not threaded in any implementation.
None.
10
Example
The example program reads values of the argument from a file, evaluates the function at each value of and prints the results.
10.1
Program Text
Program Text (s14acce.c)
10.2
Program Data
Program Data (s14acce.d)
10.3
Program Results
Program Results (s14acce.r)