NAG Library Routine Document

s14aaf  (gamma)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

s14aaf returns the value of the gamma function Γx, via the function name.

2
Specification

Fortran Interface
Function s14aaf ( x, ifail)
Real (Kind=nag_wp):: s14aaf
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (In):: x
C Header Interface
#include nagmk26.h
double  s14aaf_ ( const double *x, Integer *ifail)

3
Description

s14aaf evaluates an approximation to the gamma function Γx. The routine is based on the Chebyshev expansion:
Γ1+u=r=0arTrt,   where ​ 0u<1,t=2u-1,  
and uses the property Γ1+x=xΓx. If x=N+1+u where N is integral and 0u<1 then it follows that:
There are four possible failures for this routine:
(i) if x is too large, there is a danger of overflow since Γx could become too large to be represented in the machine;
(ii) if x is too large and negative, there is a danger of underflow;
(iii) if x is equal to a negative integer, Γx would overflow since it has poles at such points;
(iv) if x is too near zero, there is again the danger of overflow on some machines. For small x, Γx1/x , and on some machines there exists a range of nonzero but small values of x for which 1/x is larger than the greatest representable value.

4
References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications

5
Arguments

1:     x – Real (Kind=nag_wp)Input
On entry: the argument x of the function.
Constraint: x must not be zero or a negative integer.
2:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6
Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
The argument is too large. On soft failure the routine returns the approximate value of Γx at the nearest valid argument.
ifail=2
The argument is too large and negative. On soft failure the routine returns zero.
ifail=3
The argument is too close to zero. On soft failure the routine returns the approximate value of Γx at the nearest valid argument.
ifail=4
The argument is a negative integer, at which value Γx is infinite. On soft failure the routine returns a large positive value.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

Let δ and ε be the relative errors in the argument and the result respectively. If δ is somewhat larger than the machine precision (i.e., is due to data errors etc.), then ε and δ are approximately related by:
εxΨxδ  
(provided ε is also greater than the representation error). Here Ψx is the digamma function Γx Γx . Figure 1 shows the behaviour of the error amplification factor xΨx.
If δ is of the same order as machine precision, then rounding errors could make ε slightly larger than the above relation predicts.
There is clearly a severe, but unavoidable, loss of accuracy for arguments close to the poles of Γx at negative integers. However relative accuracy is preserved near the pole at x=0 right up to the point of failure arising from the danger of overflow.
Also accuracy will necessarily be lost as x becomes large since in this region
εδxlnx.  
However since Γx increases rapidly with x, the routine must fail due to the danger of overflow before this loss of accuracy is too great. (For example, for x=20, the amplification factor 60.)
Figure 1
Figure 1

8
Parallelism and Performance

s14aaf is not threaded in any implementation.

9
Further Comments

None.

10
Example

This example reads values of the argument x from a file, evaluates the function at each value of x and prints the results.

10.1
Program Text

Program Text (s14aafe.f90)

10.2
Program Data

Program Data (s14aafe.d)

10.3
Program Results

Program Results (s14aafe.r)

GnuplotProduced by GNUPLOT 4.6 patchlevel 3 −4 −2 0 2 4 −4 −3 −2 −1 0 1 2 3 4 Γ(x) x Example Program Returned Values for the Gamma Function Γ(x) gnuplot_plot_1
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017