std::lgamma, std::lgammaf, std::lgammal
来自 cppreference.com
在头文件 <cmath> 中定义 |
||
(1) | ||
float lgamma ( float num ); double lgamma ( double num ); |
(直到 C++23) | |
/* 浮点类型 */ lgamma ( /* 浮点类型 */ num ); |
(从 C++23 开始) (从 C++26 开始为 constexpr) |
|
float lgammaf( float num ); |
(2) | (从 C++11 开始) (从 C++26 开始为 constexpr) |
long double lgammal( long double num ); |
(3) | (从 C++11 开始) (从 C++26 开始为 constexpr) |
其他重载 (从 C++11 开始) |
||
在头文件 <cmath> 中定义 |
||
template< class Integer > double lgamma ( Integer num ); |
(A) | (从 C++26 开始为 constexpr) |
A) 为所有整数类型提供其他重载,这些类型被视为 double.
|
(从 C++11 开始) |
内容 |
[编辑] 参数
num | - | 浮点或整数值 |
[编辑] 返回值
如果未发生错误,则返回 num 的伽马函数的对数值,即 log
e|∫∞
0tnum-1
e-t dt|.
如果发生极点错误,则返回 +HUGE_VAL、+HUGE_VALF
或 +HUGE_VALL
。
如果发生由于溢出导致的范围错误,则返回 ±HUGE_VAL、±HUGE_VALF
或 ±HUGE_VALL
。
[编辑] 错误处理
错误报告方式如 math_errhandling 中所述。
如果 num 为零或为小于零的整数,则可能会发生极点错误。
如果实现支持 IEEE 浮点运算 (IEC 60559),则
- 如果参数为 1,则返回 +0。
- 如果参数为 2,则返回 +0。
- 如果参数为 ±0,则返回 +∞,并引发 FE_DIVBYZERO。
- 如果参数为负整数,则返回 +∞,并引发 FE_DIVBYZERO。
- 如果参数为 ±∞,则返回 +∞。
- 如果参数为 NaN,则返回 NaN。
[编辑] 说明
如果 num 为自然数,则 std::lgamma(num) 为 num - 1 的阶乘的对数。
POSIX 版本的 lgamma
不是线程安全的:函数的每次执行都会将 num 的伽马函数的符号存储在静态外部变量 signgam
中。某些实现提供 lgamma_r
,它将指向用户提供的 singgam
存储的指针作为第二个参数,并且是线程安全的。
在各种实现中存在一个名为 gamma
的非标准函数,但其定义不一致。例如,glibc 和 4.2BSD 版本的 gamma
执行 lgamma
,但 4.4BSD 版本的 gamma
执行 tgamma
。
不需要完全按照(A)提供额外的重载。它们只需要足够保证对于其整数类型的参数num,std::lgamma(num)与std::lgamma(static_cast<double>(num))具有相同的效果。
[编辑] 示例
运行这段代码
#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"; }
输出
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
[编辑] 另请参见
(C++11)(C++11)(C++11) |
伽马函数 (函数) |
C 文档 for lgamma
|
[编辑] 外部链接
Weisstein, Eric W. “对数伽马函数”。 来自 Wolfram Web 资源的 MathWorld。 |