s14ac returns a value of the function , where is the psi function .
Syntax
C# |
---|
public static double s14ac( double x, out int ifail ) |
Visual Basic |
---|
Public Shared Function s14ac ( _ x As Double, _ <OutAttribute> ByRef ifail As Integer _ ) As Double |
Visual C++ |
---|
public: static double s14ac( double x, [OutAttribute] int% ifail ) |
F# |
---|
static member s14ac : x : float * ifail : int byref -> float |
Parameters
- x
- Type: System..::..DoubleOn entry: the argument of the function.Constraint: .
- ifail
- Type: System..::..Int32%On exit: unless the method detects an error or a warning has been flagged (see [Error Indicators and Warnings]).
Return Value
s14ac returns a value of the function , where is the psi function .
Description
s14ac 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 method 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 method is derived from the method PSIFN in Amos (1983).
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
Error Indicators and Warnings
Accuracy
All constants in s14ac 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 method 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.
Parallelism and Performance
None.
Further Comments
None.
Example
The example program reads values of the argument from a file, evaluates the function at each value of and prints the results.
Example program (C#): s14ace.cs