Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The Berkeley software License Agreement specifies the terms and conditions
for redistribution.


Copyright (c) 1983 Regents of the University of California.
All rights reserved.
Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.

lgamma, lgammaf, lgammal, lgamma_r, lgammaf_r, lgammal_r, gamma, gammaf, gammal, gamma_r, gammaf_r, gammal_r - log gamma function

c99 [ flag... ] file... -lm [ library... ]
#include <math.h>

extern int signgam;

double lgamma(double x);

float lgammaf(float x);

long double lgammal(long double x);

double gamma(double x);

float gammaf(float x);

long double gammal(long double x);

double lgamma_r(double x, int *signgamp);

float lgammaf_r(float x, int *signgamp);

long double lgammal_r(long double x, int *signgamp);

double gamma_r(double x, int *signgamp);

float gammaf_r(float x, int *signgamp);

long double gammal_r(long double x, int *signgamp);

These functions return ln||~(x)|

where |~(x) = integral from 0 to +Infinity of pow(t,x-1)*exp(-t) dt

for x > 0 and |~(x) = n/(|~(1-x)sin(nx))

for x < 1.

These functions use the external integer signgam to return the sign of |~(x) while lgamma_r() and gamma_r() use the user-allocated space addressed by signgamp.

Upon successful completion, these functions return the logarithmic gamma of x.

If x is a non-positive integer, a pole error occurs and these functions return +HUGE_VAL, +HUGE_VALF, and +HUGE_VALL, respectively.

If x is NaN, a NaN is returned.

If x is 1 or 2, +0 shall be returned.

If x is \(+-Inf, +Inf is returned.

These functions will fail if:

Pole Error

An application wanting to check for exceptions should call feclearexcept(FE_ALL_EXCEPT) before calling these functions. On return, if fetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an exception has been raised. An application should either examine the return value or check the floating point exception flags to detect exceptions.

In the case of lgamma(), do not use the expression signgam*exp(lgamma(x)) to compute `g := |~(x)'

Instead compute lgamma() first:

lg = lgamma(x); g = signgam*exp(lg);

only after lgamma() has returned can signgam be correct. Note that |~(x) must overflow when x is large enough, underflow when -x is large enough, and generate a division by 0 exception at the singularities x a nonpositive integer.

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability See below.

MT-Level See below.

The lgamma(), lgammaf(), lgammal(), and gamma() functions are Standard. The lgamma_r(), lgammaf_r(), lgammal_r(), gamma_r(), gammaf_r(), and gammal_r(), functions are Stable.

The lgamma(), lgammaf(), lgammal(), gamma(), gammaf(), and gammal() functions are Unsafe in multithreaded applications. The lgamma_r(), lgammaf_r(), lgammal_r(), gamma_r(), gammaf_r(), and gammal_r() functions are MT-Safe and should be used instead.

exp(3M), feclearexcept(3M), fetestexcept(3M), isnan(3M), math.h(3HEAD), attributes(5), standards(5)

When compiling multithreaded applications, the _REENTRANT flag must be defined on the compile line. This flag should only be used in multithreaded applications.