man-pages/man3/tgamma.3

182 lines
3.9 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.\" Distributed under GPL
.\" Based on glibc infopages
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
.\" <mtk.manpages@gmail.com>
2004-11-15 08:24:41 +00:00
.\" Modified 2004-11-15, fixed error noted by Fabian Kreutz
.\" <kreutz@dbs.uni-hannover.de>
_exit.2, brk.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, getdtablesize.2, gethostname.2, getpagesize.2, getsid.2, killpg.2, mknod.2, mknodat.2, poll.2, posix_fadvise.2, pread.2, readlink.2, setpgid.2, setreuid.2, sigaltstack.2, stat.2, symlink.2, sync.2, truncate.2, vfork.2, wait.2, wait4.2, a64l.3, abs.3, acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atoi.3, cbrt.3, ceil.3, copysign.3, cosh.3, dirfd.3, div.3, ecvt.3, erf.3, erfc.3, exp.3, exp2.3, fabs.3, fdim.3, ffs.3, floor.3, fma.3, fmax.3, fmin.3, fmod.3, fpclassify.3, frexp.3, ftw.3, fwide.3, gcvt.3, getcwd.3, getdate.3, getgrent.3, gethostid.3, getpass.3, getpwent.3, getsubopt.3, getw.3, hypot.3, ilogb.3, index.3, isalpha.3, isgreater.3, iswblank.3, j0.3, ldexp.3, lockf.3, log.3, log10.3, log1p.3, logb.3, lrint.3, lround.3, mkstemp.3, mktemp.3, modf.3, mq_receive.3, mq_send.3, nan.3, nextafter.3, posix_fallocate.3, posix_memalign.3, printf.3, qecvt.3, random.3, realpath.3, remainder.3, remquo.3, rint.3, round.3, scalb.3, scalbln.3, scanf.3, siginterrupt.3, signbit.3, sigset.3, sinh.3, sqrt.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strfry.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtod.3, strtok.3, strtol.3, strtoul.3, strxfrm.3, tanh.3, tgamma.3, trunc.3, ttyslot.3, ualarm.3, usleep.3, wprintf.3, armscii-8.7, cp1251.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-3.7, iso_8859-5.7, iso_8859-6.7, iso_8859-8.7, koi8-u.7: tstamp Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 17:19:13 +00:00
.TH TGAMMA 3 2010-09-20 "GNU" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
tgamma, tgammaf, tgammal \- true gamma function
.SH SYNOPSIS
.B #include <math.h>
.sp
.BI "double tgamma(double " x );
.br
.BI "float tgammaf(float " x );
.br
.BI "long double tgammal(long double " x );
.sp
Link with \fI\-lm\fP.
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.ad l
.BR tgamma (),
.BR tgammaf (),
.BR tgammal ():
.RS 4
_XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
_POSIX_C_SOURCE\ >=\ 200112L;
.br
or
.I cc\ -std=c99
.RE
.ad
2004-11-03 13:51:07 +00:00
.SH DESCRIPTION
The Gamma function is defined by
.sp
Gamma(x) = integral from 0 to infinity of t^(x\-1) e^\-t dt
2004-11-03 13:51:07 +00:00
.sp
It is defined for every real number except for nonpositive integers.
For nonnegative integral \fIm\fP one has
2004-11-03 13:51:07 +00:00
.sp
Gamma(m+1) = m!
2004-11-03 13:51:07 +00:00
.sp
and, more generally, for all \fIx\fP:
.sp
Gamma(x+1) = x * Gamma(x)
2004-11-03 13:51:07 +00:00
.sp
2004-11-15 08:24:41 +00:00
Furthermore, the following is valid for all values of \fIx\fP
outside the poles:
2004-11-03 13:51:07 +00:00
.sp
Gamma(x) * Gamma(1 \- x) = PI / sin(PI * x)
2004-11-03 13:51:07 +00:00
.PP
.SH RETURN VALUE
On success, these functions return Gamma(x).
If
.I x
is a NaN, a NaN is returned.
If
2007-07-09 20:43:38 +00:00
.I x
is positive infinity, positive infinity is returned.
If
2007-07-09 20:43:38 +00:00
.I x
is a negative integer, or is negative infinity,
2008-08-04 16:00:58 +00:00
a domain error occurs,
and a NaN is returned.
If the result overflows,
2008-08-04 16:00:58 +00:00
a range error occurs,
and the functions return
.BR HUGE_VAL ,
.BR HUGE_VALF ,
or
.BR HUGE_VALL ,
respectively, with the correct mathematical sign.
If the result underflows,
2008-08-04 16:00:58 +00:00
a range error occurs,
and the functions return 0, with the correct mathematical sign.
If
2007-07-09 20:43:38 +00:00
.I x
is -0 or +0,
2008-08-04 16:00:58 +00:00
a pole error occurs,
and the functions return
.BR HUGE_VAL ,
.BR HUGE_VALF ,
or
.BR HUGE_VALL ,
respectively, with the same sign as the 0.
.SH ERRORS
See
.BR math_error (7)
for information on how to determine whether an error has occurred
when calling these functions.
.PP
The following errors can occur:
.TP
Domain error: \fIx\fP is a negative integer, or negative infinity
.\" FIXME . errno is not set to EDOM for x == -inf
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6809
.I errno
is set to
.BR EDOM .
An invalid floating-point exception
.RB ( FE_INVALID )
is raised (but see BUGS).
.TP
Pole error: \fIx\fP is +0 or \-0
.I errno
is set to
.BR ERANGE .
A divide-by-zero floating-point exception
.RB ( FE_DIVBYZERO )
is raised.
.TP
Range error: result overflow
.I errno
is set to
.BR ERANGE .
An overflow floating-point exception
.RB ( FE_OVERFLOW )
is raised.
.PP
glibc also gives the following error which is not specified
in C99 or POSIX.1-2001.
.TP
Range error: result underflow
.\" e.g., tgamma(-172.5) on glibc 2.8/x86-32
.\" .I errno
.\" is set to
.\" .BR ERANGE .
An underflow floating-point exception
.RB ( FE_UNDERFLOW )
is raised.
.IP
.I errno
is not set for this case.
.\" FIXME . Is it intentional that errno is not set:
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6810
.\"
.\" glibc (as at 2.8) also supports and an inexact
.\" exception for various cases.
.SH VERSIONS
These functions first appeared in glibc in version 2.1.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
C99, POSIX.1-2001.
.SH NOTES
This function had to be called "true gamma function"
since there is already a function
.BR gamma (3)
2008-08-01 05:54:27 +00:00
that returns something else (see
.BR gamma (3)
for details).
.SH BUGS
If
.I x
is negative infinity,
.I errno
is not set (it should be set to
2008-08-06 06:12:44 +00:00
.BR EDOM ).
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6809
2008-08-10 15:11:07 +00:00
In glibc versions 2.3.3 and earlier,
an argument of +0 or -0 incorrectly produced a domain error
.RI ( errno
set to
.B EDOM
and an
.B FE_INVALID
exception raised), rather than a pole error.
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR gamma (3),
.BR lgamma (3)