| Home | Libraries | People | FAQ | More

### Gamma

##### Synopsis

    #include <boost/math/special_functions/gamma.hpp>

    namespace boost{ namespace math{

    template <class T>
    calculated-result-type tgamma(T z);

    template <class T, class Policy>
    calculated-result-type tgamma(T z, const Policy&);

    template <class T>
    calculated-result-type tgamma1pm1(T dz);

    template <class T, class Policy>
    calculated-result-type tgamma1pm1(T dz, const Policy&);

    }} // namespaces

##### Description

    template <class T>
    calculated-result-type tgamma(T z);

    template <class T, class Policy>
    calculated-result-type tgamma(T z, const Policy&);

Returns the "true gamma" (hence name tgamma) of value z:

The final Policy argument is optional and can be used to control the behaviour of the function: how it handles errors, what level of precision to use etc. Refer to the policy documentation for more details.

There are effectively two versions of the tgamma function internally: a fully generic version that is slow, but reasonably accurate, and a much more efficient approximation that is used where the number of digits in the significand of T correspond to a certain Lanczos approximation. In practice any built in floating point type you will encounter has an appropriate Lanczos approximation defined for it. It is also possible, given enough machine time, to generate further Lanczos approximation's using the program libs/math/tools/lanczos_generator.cpp.

The return type of this function is computed using the result type calculation rules: the result is `double` when T is an integer type, and T otherwise.

    template <class T>
    calculated-result-type tgamma1pm1(T dz);

    template <class T, class Policy>
    calculated-result-type tgamma1pm1(T dz, const Policy&);

Returns `tgamma(dz + 1) - 1`. Internally the implementation does not make use of the addition and subtraction implied by the definition, leading to accurate results even for very small `dz`. However, the implementation is capped to either 35 digit accuracy, or to the precision of the Lanczos approximation associated with type T, whichever is more accurate.

The return type of this function is computed using the result type calculation rules: the result is `double` when T is an integer type, and T otherwise.

The final Policy argument is optional and can be used to control the behaviour of the function: how it handles errors, what level of precision to use etc. Refer to the policy documentation for more details.

##### Accuracy

The following table shows the peak errors (in units of epsilon) found on various platforms with various floating point types, along with comparisons to other common libraries. Unless otherwise specified any floating point type that is narrower than the one shown will have effectively zero error.

Table 6.1. Error rates for tgamma

| Microsoft Visual C++ version 12.0 Win32 double | GNU C++ version 5.1.0 linux double | GNU C++ version 5.1.0 linux long double | Sun compiler version 0x5130 Sun Solaris long double
--- | --- | --- | --- | ---
factorials | Max = 1.85ε (Mean = 0.491ε) (<math.h>: Max = 3.17ε (Mean = 0.928ε)) | Max = 0ε (Mean = 0ε) (GSL 1.16: Max = 3.95ε (Mean = 0.783ε)) (Rmath 3.0.2: Max = 314ε (Mean = 93.4ε)) (Cephes: Max = 3.19ε (Mean = 0.884ε)) | Max = 1.96ε (Mean = 0.483ε) (<tr1/cmath>: Max = 1.66ε (Mean = 0.584ε)) (<math.h>: Max = 1.66ε (Mean = 0.584ε)) | Max = 172ε (Mean = 41ε) (<math.h>: Max = 0ε (Mean = 0ε))
near 0 | Max = 1.96ε (Mean = 0.684ε) (<math.h>: Max = 1ε (Mean = 0.405ε)) | Max = 0ε (Mean = 0ε) (GSL 1.16: Max = 4.51ε (Mean = 1.92ε)) (Rmath 3.0.2: Max = 1ε (Mean = 0.335ε)) (Cephes: Max = 1ε (Mean = 0.548ε)) | Max = 2ε (Mean = 0.73ε) (<tr1/cmath>: Max = 1ε (Mean = 0.376ε)) (<math.h>: Max = 1ε (Mean = 0.376ε)) | Max = 2ε (Mean = 0.647ε) (<math.h>: Max = 0.5ε (Mean = 0.0791ε))
near 1 | Max = 2ε (Mean = 0.865ε) (<math.h>: Max = 1ε (Mean = 0.4ε)) | Max = 0ε (Mean = 0ε) (GSL 1.16: Max = 4.41ε (Mean = 1.81ε)) (Rmath 3.0.2: Max = 1ε (Mean = 0.32ε)) (Cephes: Max = 1ε (Mean = 0.518ε)) | Max = 2ε (Mean = 0.85ε) (<tr1/cmath>: Max = 0.918ε (Mean = 0.203ε)) (<math.h>: Max = 0.918ε (Mean = 0.203ε)) | Max = 3.01ε (Mean = 1.06ε) (<math.h>: Max = 1ε (Mean = 0.175ε))
near 2 | Max = 2ε (Mean = 0.995ε) (<math.h>: Max = 0ε (Mean = 0ε)) | Max = 0ε (Mean = 0ε) (GSL 1.16: Max = 7.95ε (Mean = 3.12ε)) (Rmath 3.0.2: Max = 1ε (Mean = 0.191ε)) (Cephes: Max = 1.09ε (Mean = 0.502ε)) | Max = 2ε (Mean = 0.913ε) (<tr1/cmath>: Max = 0.558ε (Mean = 0.298ε)) (<math.h>: Max = 0.558ε (Mean = 0.298ε)) | Max = 5.01ε (Mean = 1.89ε) (<math.h>: Max = 0ε (Mean = 0ε))
near -10 | Max = 1.73ε (Mean = 0.729ε) (<math.h>: Max = 0.866ε (Mean = 0.445ε)) | Max = 0ε (Mean = 0ε) (GSL 1.16: Max = 2.6ε (Mean = 1.05ε)) (Rmath 3.0.2: Max = 6.34e+05ε (Mean = 1.2e+05ε)) (Cephes: Max = 2.6ε (Mean = 0.956ε)) | Max = 2.6ε (Mean = 0.985ε) (<tr1/cmath>: Max = 2.26ε (Mean = 1.08ε)) (<math.h>: Max = 2.26ε (Mean = 1.08ε)) | Max = 1.75ε (Mean = 0.819ε) (<math.h>: Max = 0ε (Mean = 0ε))
near -55 | Max = 1.8ε (Mean = 0.817ε) (<math.h>: Max = 3.87e+004ε (Mean = 6.71e+003ε)) | Max = 0ε (Mean = 0ε) (GSL 1.16: Max = 1.8ε (Mean = 0.782ε)) (Rmath 3.0.2: Max = 6.36e+06ε (Mean = 1.13e+06ε)) (Cephes: Max = 2.7ε (Mean = 0.988ε)) | Max = 1.8ε (Mean = 0.847ε) (<tr1/cmath>: Max = 1.79ε (Mean = 0.75ε)) (<math.h>: Max = 1.79ε (Mean = 0.75ε)) | Max = 98.5ε (Mean = 53.4ε) (<math.h>: Max = 0ε (Mean = 0ε))

Table 6.2. Error rates for tgamma1pm1

| Microsoft Visual C++ version 12.0 Win32 double | GNU C++ version 5.1.0 linux double | GNU C++ version 5.1.0 linux long double | Sun compiler version 0x5130 Sun Solaris long double
--- | --- | --- | --- | ---
tgamma1pm1(dz) | Max = 0.982ε (Mean = 0.399ε) | Max = 0ε (Mean = 0ε) | Max = 1.12ε (Mean = 0.49ε) | Max = 3.97ε (Mean = 0.713ε)

##### Testing

The gamma is relatively easy to test: factorials and half-integer factorials can be calculated exactly by other means and compared with the gamma function. In addition, some accuracy tests in known tricky areas were computed at high precision using the generic version of this function.

The function `tgamma1pm1` is tested against values calculated very naively using the formula `tgamma(1+dz)-1` with a lanczos approximation accurate to around 100 decimal digits.

##### Implementation

The generic version of the `tgamma` function is implemented Sterling's approximation for lgamma for large z:

Following exponentiation, downward recursion is then used for small values of z.

For types of known precision the Lanczos approximation is used, a traits class `boost::math::lanczos::lanczos_traits` maps type T to an appropriate approximation.

For z in the range -20 < z < 1 then recursion is used to shift to z > 1 via:

For very small z, this helps to preserve the identity:

For z < -20 the reflection formula:

is used. Particular care has to be taken to evaluate the `z * sin(π * z)` part: a special routine is used to reduce z prior to multiplying by π to ensure that the result in is the range [0, π/2]. Without this an excessive amount of error occurs in this region (which is hard enough already, as the rate of change near a negative pole is exceptionally high).

Finally if the argument is a small integer then table lookup of the factorial is used.

The function `tgamma1pm1` is implemented using rational approximations devised by JM in the region `-0.5 < dz < 2`. These are the same approximations (and internal routines) that are used for lgamma, and so aren't detailed further here. The result of the approximation is `log(tgamma(dz+1))` which can fed into expm1 to give the desired result. Outside the range `-0.5 < dz < 2` then the naive formula `tgamma1pm1(dz) = tgamma(dz+1)-1` can be used directly.