Difference between revisions of "cpp/numeric/math/lgamma"

Latest revision as of 09:10, 28 June 2023

Defined in header `<cmath>`
	(1)
float lgamma ( float num ); double lgamma ( double num ); long double lgamma ( long double num );			(until C++23)
/* floating-point-type / lgamma ( / floating-point-type */ num );			(since C++23) (constexpr since C++26)
float lgammaf( float num );		(2)	(since C++11) (constexpr since C++26)
long double lgammal( long double num );		(3)	(since C++11) (constexpr since C++26)
Additional overloads (since C++11)
Defined in header `<cmath>`
template< class Integer > double lgamma ( Integer num );		(A)	(constexpr since C++26)

1-3) Computes the natural logarithm of the absolute value of the gamma function of num. The library provides overloads of std::lgamma for all cv-unqualified floating-point types as the type of the parameter.(since C++23)

A) Additional overloads are provided for all integer types, which are treated as double.

(since C++11)

If the argument is 1, +0 is returned.
If the argument is 2, +0 is returned.
If the argument is ±0, +∞ is returned and FE_DIVBYZERO is raised.
If the argument is a negative integer, +∞ is returned and FE_DIVBYZERO is raised.
If the argument is ±∞, +∞ is returned.
If the argument is NaN, NaN is returned.

[edit] Notes

If num is a natural number, std::lgamma(num) is the logarithm of the factorial of num - 1.

The POSIX version of lgamma is not thread-safe: each execution of the function stores the sign of the gamma function of num in the static external variable signgam. Some implementations provide lgamma_r, which takes a pointer to user-provided storage for singgam as the second parameter, and is thread-safe.

There is a non-standard function named gamma in various implementations, but its definition is inconsistent. For example, glibc and 4.2BSD version of gamma executes lgamma, but 4.4BSD version of gamma executes tgamma.

The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their argument num of integer type, std::lgamma(num) has the same effect as std::lgamma(static_cast<double>(num)).

[edit] Example

Run this code

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
const double pi = std::acos(-1); // or std::numbers::pi since C++20
 
int main()
{
    std::cout << "lgamma(10) = " << std::lgamma(10)
              << ", log(9!) = " << std::log(std::tgamma(10))
              << ", exp(lgamma(10)) = " << std::exp(std::lgamma(10)) << '\n'
              << "lgamma(0.5) = " << std::lgamma(0.5)
              << ", log(sqrt(pi)) = " << std::log(std::sqrt(pi)) << '\n';
 
    // special values
    std::cout << "lgamma(1) = " << std::lgamma(1) << '\n'
              << "lgamma(+Inf) = " << std::lgamma(INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "lgamma(0) = " << std::lgamma(0) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

Output:

lgamma(10) = 12.8018, log(9!) = 12.8018, exp(lgamma(10)) = 362880
lgamma(0.5) = 0.572365, log(sqrt(pi)) = 0.572365
lgamma(1) = 0
lgamma(+Inf) = inf
lgamma(0) = inf
    errno == ERANGE: Numerical result out of range
    FE_DIVBYZERO raised

[edit] See also

tgammatgammaftgammal (C++11)(C++11)(C++11)	gamma function (function) [edit]
C documentation for lgamma

[edit] External links

Weisstein, Eric W. "Log Gamma Function." From MathWorld — A Wolfram Web Resource.

@@ Line 1: / Line 1: @@
-{{cpp/title|lgamma}}
+{{cpp/title|lgamma|lgammaf|lgammal}}
-{{cpp/numeric/math/sidebar}}
+{{cpp/numeric/math/navbar}}
-{{ddcl list begin}}
+{{cpp/numeric/math/declarations
-{{ddcl list header | cmath}}
+|family=lgamma
-{{ddcl list item | notes={{mark c++11 feature}} |
+|param1=num
-float       lgamma( float arg );
+|constexpr_since=26
+|desc=Computes the natural logarithm of the absolute value of the {{enwiki|gamma function}} of {{c|num}}.
 }}
-{{ddcl list item | notes={{mark c++11 feature}} |
-double      lgamma( double arg );
-}}
-{{ddcl list item | notes={{mark c++11 feature}} |
-long double lgamma( long double arg );
-}}
-{{ddcl list end}}
-Computes the natural logarithm of the absolute value of the [[enwiki:Gamma function|gamma function]] of {{tt|arg}}.
 ===Parameters===
-{{param list begin}}
+{{par begin}}
-{{param list item | arg | floating point value}}
+{{par|num|floating-point or integer value}}
-{{param list end}}
+{{par end}}
 ===Return value===
+If no errors occur, the value of the logarithm of the gamma function of {{c|num}}, that is {{mathjax-or|1=\(\log_{e}{{!}}{\int_0^\infty t^{num-1} e^{-t} \mathsf{d}t}{{!}}\)|2=log{{su|b=e}}{{!}}{{minteg|0|∞|''t''{{su|p=num-1}} {{mexp|-t}} d''t''}}{{!}}}}, is returned.
-The value of the logarithm of the gamma function of {{tt|arg}}, that is {{math|log{{su|b=e}}{{!}}{{minteg|0|∞|''t''{{su|p=arg-1}} {{mexp|-t}} d''t''}}{{!}}}}.
+If a pole error occurs, {{lc|HUGE_VAL|+HUGE_VAL}}, {{tt|+HUGE_VALF}}, or {{tt|+HUGE_VALL}} is returned.
-If {{tt|arg}} is a natural number, {{cpp|std::lgamma(arg)}} is the logarithm of the factorial of {{tt|arg-1}}.
+If a range error due to overflow occurs, {{lc|HUGE_VAL|±HUGE_VAL}}, {{tt|±HUGE_VALF}}, or {{tt|±HUGE_VALL}} is returned.
-===Exceptions===
+===Error handling===
-If {{tt|arg}} is zero or a negative integer, pole error may occur and {{cpp|FE_INVALID}} or {{cpp|FE_DIVBYZERO}} may be raised.
+Errors are reported as specified in {{lc|math_errhandling}}.
-If {{tt|arg}} is too large, range error may occur and {{cpp|FE_OVERFLOW}} may be raised.
+If {{c|num}} is zero or is an integer less than zero, a pole error may occur.
+If the implementation supports IEEE floating-point arithmetic (IEC 60559),
+* If the argument is 1, +0 is returned.
+* If the argument is 2, +0 is returned.
+* If the argument is ±0, +∞ is returned and {{lc|FE_DIVBYZERO}} is raised.
+* If the argument is a negative integer, +∞ is returned and {{lc|FE_DIVBYZERO}} is raised.
+* If the argument is ±∞, +∞ is returned.
+* If the argument is NaN, NaN is returned.
 ===Notes===
+If {{c|num}} is a natural number, {{c|std::lgamma(num)}} is the logarithm of the factorial of {{c|num - 1}}.
-[http://pubs.opengroup.org/onlinepubs/9699919799/functions/lgamma.html POSIX specification] additionally requires that each execution of {{cpp|lgamma}} stores the sign of the gamma function of {{tt|arg}} in the external variable {{tt|signgam}}.
+The [https://pubs.opengroup.org/onlinepubs/9699919799/functions/lgamma.html POSIX version of {{tt|lgamma}}] is not thread-safe: each execution of the function stores the sign of the gamma function of {{c|num}} in the static external variable {{tt|signgam}}. Some implementations provide {{tt|lgamma_r}}, which takes a pointer to user-provided storage for {{tt|singgam}} as the second parameter, and is thread-safe.
-===See also===
+There is a non-standard function named {{tt|gamma}} in various implementations, but its definition is inconsistent. For example, glibc and 4.2BSD version of {{tt|gamma}} executes {{tt|lgamma}}, but 4.4BSD version of {{tt|gamma}} executes {{tt|tgamma}}.
-{{dcl list begin}}
+{{cpp/numeric/math/additional integer overload note|lgamma}}
-{{dcl list template | cpp/numeric/math/dcl list tgamma}}
-{{dcl list end}}
+===Example===
+{{example
+|code=
+#include <cerrno>
+#include <cfenv>
+#include <cmath>
+#include <cstring>
+#include <iostream>
+// #pragma STDC FENV_ACCESS ON
+const double pi = std::acos(-1); // or std::numbers::pi since C++20
+int main()
+{
+    std::cout << "lgamma(10) = " << std::lgamma(10)
+              << ", log(9!) = " << std::log(std::tgamma(10))
+              << ", exp(lgamma(10)) = " << std::exp(std::lgamma(10)) << '\n'
+              << "lgamma(0.5) = " << std::lgamma(0.5)
+              << ", log(sqrt(pi)) = " << std::log(std::sqrt(pi)) << '\n';
+    // special values
+    std::cout << "lgamma(1) = " << std::lgamma(1) << '\n'
+              << "lgamma(+Inf) = " << std::lgamma(INFINITY) << '\n';
+    // error handling
+    errno = 0;
+    std::feclearexcept(FE_ALL_EXCEPT);
+    std::cout << "lgamma(0) = " << std::lgamma(0) << '\n';
+    if (errno == ERANGE)
+        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
+    if (std::fetestexcept(FE_DIVBYZERO))
+        std::cout << "    FE_DIVBYZERO raised\n";
+}
+|output=
+lgamma(10) = 12.8018, log(9!) = 12.8018, exp(lgamma(10)) = 362880
+lgamma(0.5) = 0.572365, log(sqrt(pi)) = 0.572365
+lgamma(1) = 0
+lgamma(+Inf) = inf
+lgamma(0) = inf
+    errno == ERANGE: Numerical result out of range
+    FE_DIVBYZERO raised
+}}
+===See also===
+{{dsc begin}}
+{{dsc inc|cpp/numeric/math/dsc tgamma}}
+{{dsc see c|c/numeric/math/lgamma}}
+{{dsc end}}
 ===External links===
-[http://mathworld.wolfram.com/LogGammaFunction.html Weisstein, Eric W. "Log Gamma Function."] From MathWorld--A Wolfram Web Resource.
+{{eli|[https://mathworld.wolfram.com/LogGammaFunction.html Weisstein, Eric W. "Log Gamma Function."] From MathWorld &mdash; A Wolfram Web Resource.}}
+{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Metaprogramming library (C++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (C++17)
Regular expressions library (C++11)
Concurrency support library (C++11)
Execution support library (C++26)
Technical specifications
Symbols index
External libraries

cppreference.com

Namespaces

Variants

Views

Actions

Difference between revisions of "cpp/numeric/math/lgamma"

Latest revision as of 09:10, 28 June 2023

Contents

[edit] Parameters

[edit] Return value

[edit] Error handling

[edit] Notes

[edit] Example

[edit] See also

[edit] External links

Navigation

Toolbox