Lgamma

定义于头文件 <cmath> 中。

描述

计算 num 的伽马函数绝对值的自然对数。
​库为所有 cv-unqualified 浮点类型提供了 std::lgamma 的重载作为参数 num 的类型  （自 C++23 起）。

​为所有整数类型提供了额外的重载，它们被视为 double。

声明

C++23

// 1)
/* floating-point-type */ lgamma( /* floating-point-type */ num );
// 2)
float lgammaf( float num );
// 3)
long double lgammal( long double num );

附加重载

// 4)
template< class Integer >
double lgamma ( Integer num );

C++11

// 1)
float lgamma ( float num );
// 2)
double lgamma ( double num );
//3)
long double lgamma ( long double num );
// 4)
float erfcf( float num );
// 5)
long double erfcl( long double num );

附加重载

// 6)
template< class Integer >
double lgamma ( Integer num );

参数

​num - 浮点或整数值

返回值

如果未发生错误，则返回 num 的伽马函数对数值，即 math here。

如果发生极点错误，则返回 +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。

额外的重载不需要严格按照额外的重载提供。它们只需要足以确保对于其整数类型参数 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