s14ab returns the value of the logarithm of the gamma function, .
Syntax
C# |
---|
public static double s14ab( double x, out int ifail ) |
Visual Basic |
---|
Public Shared Function s14ab ( _ x As Double, _ <OutAttribute> ByRef ifail As Integer _ ) As Double |
Visual C++ |
---|
public: static double s14ab( double x, [OutAttribute] int% ifail ) |
F# |
---|
static member s14ab : 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
s14ab returns the value of the logarithm of the gamma function, .
Description
s14ab calculates an approximate value for . It is based on rational Chebyshev expansions.
Denote by a ratio of polynomials of degree in the numerator and in the denominator. Then:
- for ,
- for ,
- for ,
- for ,
- and for ,
(1)
For each expansion, the specific values of and are selected to be minimal such that the maximum relative error in the expansion is of the order , where is the maximum number of decimal digits that can be accurately represented for the particular implementation (see x02be).
Let denote machine precision and let denote the largest positive model number (see x02al). For the value is not defined; s14ab returns zero and exits with . It also exits with when , and in this case the value is returned. For in the interval , the function to machine accuracy.
Now denote by the largest allowable argument for on the machine. For the term in Equation (1) is negligible. For there is a danger of setting overflow, and so s14ab exits with and returns . The value of is given in the Users' Note for your implementation.
References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Cody W J and Hillstrom K E (1967) Chebyshev approximations for the natural logarithm of the gamma function Math.Comp. 21 198–203
Error Indicators and Warnings
Errors or warnings detected by the method:
- On entry, . If the function is undefined; on failure, the function value returned is zero. If and failure is selected, the function value returned is the largest machine number (see x02al).
- On entry, (see [Description]). On failure, the function value returned is the largest machine number (see x02al).
Accuracy
Let and be the relative errors in the argument and result respectively, and be the absolute error in the result.
If is somewhat larger than machine precision, then
where is the digamma function . Figure 1 and Figure 2 show the behaviour of these error amplification factors.
These show that relative error can be controlled, since except near relative error is attenuated by the function or at least is not greatly amplified.
For large , and for small , .
The function has zeros at and and hence relative accuracy is not maintainable near those points. However absolute accuracy can still be provided near those zeros as is shown above.
If however, is of the order of machine precision, then rounding errors in the method's internal arithmetic may result in errors which are slightly larger than those predicted by the equalities. It should be noted that even in areas where strong attenuation of errors is predicted the relative precision is bounded by the effective machine precision.
Parallelism and Performance
None.
Further Comments
None.
Example
This example reads values of the argument from a file, evaluates the function at each value of and prints the results.
Example program (C#): s14abe.cs