mars.tensor.special.loggamma#

mars.tensor.special.loggamma(x, **kwargs)[source]#

Principal branch of the logarithm of the gamma function.

Defined to be \(\log(\Gamma(x))\) for \(x > 0\) and extended to the complex plane by analytic continuation. The function has a single branch cut on the negative real axis.

Parameters

z (array-like) – Values in the complex plain at which to compute loggamma
out (ndarray, optional) – Output array for computed values of loggamma

Returns

loggamma – Values of loggamma at z.

Return type

ndarray

Notes

It is not generally true that \(\log\Gamma(z) = \log(\Gamma(z))\), though the real parts of the functions do agree. The benefit of not defining loggamma as \(\log(\Gamma(z))\) is that the latter function has a complicated branch cut structure whereas loggamma is analytic except for on the negative real axis.

The identities

\[\begin{split}\exp(\log\Gamma(z)) &= \Gamma(z) \\ \log\Gamma(z + 1) &= \log(z) + \log\Gamma(z)\end{split}\]

make loggamma useful for working in complex logspace.

On the real line loggamma is related to gammaln via exp(loggamma(x + 0j)) = gammasgn(x)*exp(gammaln(x)), up to rounding error.

The implementation here is based on [hare1997].