man-pages/man3/tgamma.3.html
2021-03-31 01:06:50 +01:00

351 lines
6.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of TGAMMA</TITLE>
</HEAD><BODY>
<H1>TGAMMA</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
tgamma, tgammaf, tgammal - true gamma function
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:///usr/include/math.h">math.h</A>&gt;</B>
<P>
<B>double tgamma(double </B><I>x</I><B>);</B>
<BR>
<B>float tgammaf(float </B><I>x</I><B>);</B>
<BR>
<B>long double tgammal(long double </B><I>x</I><B>);</B>
<P>
Link with <I>-lm</I>.
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>tgamma</B>(),
<B>tgammaf</B>(),
<B>tgammal</B>():
<DL COMPACT><DT id="1"><DD>
_ISOC99_SOURCE ||
_POSIX_C_SOURCE&nbsp;&gt;=&nbsp;200112L
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
These functions calculate the Gamma function of
<I>x</I>.
<P>
The Gamma function is defined by
<P>
<DL COMPACT><DT id="2"><DD>
Gamma(x) = integral from 0 to infinity of t^(x-1) e^-t dt
</DL>
<P>
It is defined for every real number except for nonpositive integers.
For nonnegative integral
<I>m</I>
one has
<P>
<DL COMPACT><DT id="3"><DD>
Gamma(m+1) = m!
</DL>
<P>
and, more generally, for all
<I>x</I>:
<P>
<DL COMPACT><DT id="4"><DD>
Gamma(x+1) = x * Gamma(x)
</DL>
<P>
Furthermore, the following is valid for all values of
<I>x</I>
outside the poles:
<P>
<DL COMPACT><DT id="5"><DD>
Gamma(x) * Gamma(1 - x) = PI / sin(PI * x)
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these functions return Gamma(x).
<P>
If
<I>x</I>
is a NaN, a NaN is returned.
<P>
If
<I>x</I>
is positive infinity, positive infinity is returned.
<P>
If
<I>x</I>
is a negative integer, or is negative infinity,
a domain error occurs,
and a NaN is returned.
<P>
If the result overflows,
a range error occurs,
and the functions return
<B>HUGE_VAL</B>,
<B>HUGE_VALF</B>,
or
<B>HUGE_VALL</B>,
respectively, with the correct mathematical sign.
<P>
If the result underflows,
a range error occurs,
and the functions return 0, with the correct mathematical sign.
<P>
If
<I>x</I>
is -0 or +0,
a pole error occurs,
and the functions return
<B>HUGE_VAL</B>,
<B>HUGE_VALF</B>,
or
<B>HUGE_VALL</B>,
respectively, with the same sign as the 0.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
See
<B><A HREF="/cgi-bin/man/man2html?7+math_error">math_error</A></B>(7)
for information on how to determine whether an error has occurred
when calling these functions.
<P>
The following errors can occur:
<DL COMPACT>
<DT id="6">Domain error: <I>x</I> is a negative integer, or negative infinity<DD>
<I>errno</I>
is set to
<B>EDOM</B>.
An invalid floating-point exception
(<B>FE_INVALID</B>)
is raised (but see BUGS).
<DT id="7">Pole error: <I>x</I> is +0 or -0<DD>
<I>errno</I>
is set to
<B>ERANGE</B>.
A divide-by-zero floating-point exception
(<B>FE_DIVBYZERO</B>)
is raised.
<DT id="8">Range error: result overflow<DD>
<I>errno</I>
is set to
<B>ERANGE</B>.
An overflow floating-point exception
(<B>FE_OVERFLOW</B>)
is raised.
</DL>
<P>
glibc also gives the following error which is not specified
in C99 or POSIX.1-2001.
<DL COMPACT>
<DT id="9">Range error: result underflow<DD>
An underflow floating-point exception
(<B>FE_UNDERFLOW</B>)
is raised, and
<I>errno</I>
is set to
<B>ERANGE</B>.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
These functions first appeared in glibc in version 2.1.
<A NAME="lbAH">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>tgamma</B>(),
<B>tgammaf</B>(),
<B>tgammal</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAI">&nbsp;</A>
<H2>CONFORMING TO</H2>
C99, POSIX.1-2001, POSIX.1-2008.
<A NAME="lbAJ">&nbsp;</A>
<H2>NOTES</H2>
This function had to be called &quot;true gamma function&quot;
since there is already a function
<B><A HREF="/cgi-bin/man/man2html?3+gamma">gamma</A></B>(3)
that returns something else (see
<B><A HREF="/cgi-bin/man/man2html?3+gamma">gamma</A></B>(3)
for details).
<A NAME="lbAK">&nbsp;</A>
<H2>BUGS</H2>
Before version 2.18, the glibc implementation of these functions did not set
<I>errno</I>
to
<B>EDOM</B>
when
<I>x</I>
is negative infinity.
<P>
Before glibc 2.19,
the glibc implementation of these functions did not set
<I>errno</I>
to
<B>ERANGE</B>
on an underflow range error.
<I>x</I>
<P>
In glibc versions 2.3.3 and earlier,
an argument of +0 or -0 incorrectly produced a domain error
(<I>errno</I>
set to
<B>EDOM</B>
and an
<B>FE_INVALID</B>
exception raised), rather than a pole error.
<A NAME="lbAL">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+gamma">gamma</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+lgamma">lgamma</A></B>(3)
<A NAME="lbAM">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="14"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="15"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="16"><A HREF="#lbAH">ATTRIBUTES</A><DD>
<DT id="17"><A HREF="#lbAI">CONFORMING TO</A><DD>
<DT id="18"><A HREF="#lbAJ">NOTES</A><DD>
<DT id="19"><A HREF="#lbAK">BUGS</A><DD>
<DT id="20"><A HREF="#lbAL">SEE ALSO</A><DD>
<DT id="21"><A HREF="#lbAM">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:58 GMT, March 31, 2021
</BODY>
</HTML>