Log1p

定义于头文件 <cmath> 中。

描述

计算 1 + num 的自然对数（以 e 为底）。如果 num 接近零，此函数比表达式 std::log(1 + num) 更精确。额外的重载为所有整数类型提供，这些类型被视为 double。

声明

C++23

// 1)
/* floating-point-type */ log1p( /* floating-point-type */ num );
// 2)
float log1pf( float num );
// 3)
long double log1pl( long double num );

附加重载

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

C++11

// 1)
float log1p ( float num );
// 2)
double log1p ( double num );
// 3)
long double log1p ( long double num );
// 4)
float log1pf( float num );
// 5)
long double log1pl( long double num );

附加重载

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

参数

​num - 浮点或整数值

返回值

如果没有发生错误，返回 ln(1+num)。

如果发生域错误，则返回实现定义的值（如果支持，返回 NaN）。

如果发生极点错误，则返回-HUGE_VAL、-HUGE_VALF或-HUGE_VALL。

如果因下溢导致范围错误，则返回正确结果（舍入后）。

错误处理

错误按 math_errhandling 中指定的方式报告。

如果 num 小于零，则发生域错误。

如果 num 为零，则可能发生极点错误。

如果实现支持 IEEE 浮点运算（IEC 60559）

如果参数是 ±0，则返回 -∞ 并引发 FE_DIVBYZERO。
如果参数为 1，则返回 +0
如果参数是负数，则返回 NaN 并引发 FE_INVALID。
如果参数为 +∞，则返回 +∞
如果参数为 NaN，则返回 NaN

备注

函数 std::expm1 和 std::log1p 对于金融计算非常有用，例如，在计算小额每日利率时：(1+x)n-1 可以表示为 std::expm1(n * std::log1p(x))。这些函数还简化了精确反双曲函数的编写。

不需要严格按照 附加重载 提供附加重载。它们只需要足以确保对于它们的第一个参数 num1 和第二个参数 num2

如果 num1 或 num2 的类型是 long double，则
std::log1p(num1, num2) 的效果与
​std::log1p(static_cast<long double>(num1), static_cast<long double>(num2)) 相同。

否则，如果 num1 和/或 num2 的类型是 double 或整数类型，则
std::log1p(num1, num2) 的效果与
​std::log1p(static_cast<double>(num1), static_cast<double>(num2)) 相同。

​否则，如果 num1 或 num2 的类型为 float，则
std::log1p(num1, num2) 的效果与
​std::log1p(static_cast<float>(num1), static_cast<float>(num2)) 相同。 (直到 C++23)

如果 num1 和 num2 具有算术类型，则
std::log1p(num1, num2) 的效果与
std::log1p(static_cast</* common-floating-point-type */>(num1), static_cast</* common-floating-point-type */>(num2)) .

其中 /* common-floating-point-type */ 是 num1 和 num2 类型之间具有最大浮点转换等级和最大浮点转换子等级的浮点类型，整数类型的参数被认为具有与 double 相同的浮点转换等级。

如果不存在具有最高等级和子等级的浮点类型，则重载决议不会从提供的重载中产生可用的候选。

示例

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout 
        << "log1p(0) = " 
        << log1p(0) << '\n'
        << "Interest earned in 2 days on $100, compounded daily at 1%\n"
        << "    on a 30/360 calendar = "
        << 100 * expm1(2 * log1p(0.01 / 360)) << '\n'
        << "log(1+1e-16) = " 
        << std::log(1 + 1e-16)
        << ", but log1p(1e-16) = " 
        << std::log1p(1e-16) << '\n';
 
    // special values
    std::cout 
        << "log1p(-0) = " 
        << std::log1p(-0.0) << '\n'
        << "log1p(+Inf) = " 
        << std::log1p(INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout 
        << "log1p(-1) = " 
        << std::log1p(-1) << '\n';
 
    if (errno == ERANGE)
        std::cout 
            << "errno == ERANGE: " 
            << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout 
            << "FE_DIVBYZERO raised\n";
}

可能结果

log1p(0) = 0
Interest earned in 2 days on $100, compounded daily at 1%
    on a 30/360 calendar = 0.00555563
log(1+1e-16) = 0, but log1p(1e-16) = 1e-16
log1p(-0) = -0
log1p(+Inf) = inf
log1p(-1) = -inf
errno == ERANGE: Result too large
FE_DIVBYZERO raised