std::log1p, std::log1pf, std::log1pl

来自cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基本运算
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
指数函数
(C++11)
(C++11)
log1p
(C++11)
(C++11)
幂函数
(C++11)
(C++11)
三角与双曲函数
(C++11)
(C++11)
(C++11)
误差与伽马函数
(C++11)
(C++11)
(C++11)
(C++11)
临近整数的浮点运算
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
浮点操作函数
(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)
分类/比较
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
宏常量
(C++11)(C++11)(C++11)(C++11)(C++11)
 
在标头 <cmath> 定义
(1)
float       log1p ( float num );

double      log1p ( double num );

long double log1p ( long double num );
(C++11 起)
(C++23 前)
/* 浮点类型 */ log1p( /* 浮点类型 */ num );
(C++23 起)
float       log1pf( float num );
(2) (C++11 起)
long double log1pl( long double num );
(3) (C++11 起)
在标头 <cmath> 定义
template< class Integer >
double      log1p ( Integer num );
(4) (C++11 起)
1-3) 计算 1 + num 的自然(底 e)对数。如果 num 接近零,那么此函数比表达式 std::log(1 + num) 更精确。标准库提供所有以无 cv 限定的浮点类型作为参数 num 的类型的 std::log1p 重载。 (C++23 起)
A) 为所有整数类型提供额外重载,将它们当做 double

参数

num - 浮点或整数值

返回值

在没有发生错误时返回 ln(1+num)

如果发生定义域错误,那么返回值由实现定义(在受支持平台上是 NaN)。

如果发生极点错误,那么返回 -HUGE_VAL-HUGE_VALF-HUGE_VALL

如果发生下溢导致的值域错误,那么返回(舍入后的)正确结果。

错误处理

报告 math_errhandling 中指定的错误。

如果 num 小于 -1,那么发生定义域错误。

如果 num-1,那么可能发生极点错误。

如果实现支持 IEEE 浮点算术(IEC 60559),那么

  • 如果参数是 ±0,那么返回不修改的参数。
  • 如果参数是 -1,那么返回 -∞ 并引发 FE_DIVBYZERO
  • 如果参数小于 -1,那么返回 NaN 并引发 FE_INVALID
  • 如果参数是 +∞,那么返回 +∞。
  • 如果参数是 NaN,那么返回 NaN。

注解

函数 std::expm1std::log1p 对于金融计算有用:例如在计算小的日利率时: (1+x)n
-1
能表示为 std::expm1(n * std::log1p(x))。这些函数也简化书写精确的反双曲函数。

额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的第一个实参 num1 和第二个实参 num2 满足以下要求:

  • 如果 num1num2 具有 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))
    的效果相同。
  • 否则,如果 num1num2 具有 float 类型,那么 std::log1p(num1, num2)std::log1p(static_cast<float>(num1),
               static_cast<float>(num2))
    的效果相同。
(C++23 前)

如果 num1num2 具有算术类型,那么 std::log1p(num1, num2)std::log1p(static_cast</* 公共浮点类型 */>(num1),
           static_cast</* 公共浮点类型 */>(num2))
的效果相同,其中 /* 公共浮点类型 */num1num2 的类型中浮点转换等级浮点转换子等级最高的浮点类型,整数类型的实参被视为具有与 double 相等的浮点转换等级。

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

(C++23 起)

示例

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "log1p(0) = " << log1p(0) << '\n'
              << "在假定每月只有 30 天的日历上每天计算复利时,\n"
              << "    2 天以 1% 利率可以获得的利息 = "
              << 100 * expm1(2 * log1p(0.01 / 360)) << '\n'
              << "log(1+1e-16) = " << std::log(1 + 1e-16)
              << ",但 log1p(1e-16) = " << std::log1p(1e-16) << '\n';
 
    // 特殊值
    std::cout << "log1p(-0) = " << std::log1p(-0.0) << '\n'
              << "log1p(+Inf) = " << std::log1p(INFINITY) << '\n';
 
    // 错误处理
    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\n";
}

可能的输出:

log1p(0) = 0
在假定每月只有 30 天的日历上每天计算复利时,
    2 天以 1% 利率可以获得的利息 = 0.00555563
log(1+1e-16) = 0,但 log1p(1e-16) = 1e-16
log1p(-0) = -0
log1p(+Inf) = inf
log1p(-1) = -inf
    errno == ERANGE: Result too large
    发生 FE_DIVBYZERO

参阅

(C++11)(C++11)
计算自然(以 e 为底)对数(ln(x)
(函数)
(C++11)(C++11)
计算常用(以 10 为底)对数(log10(x)
(函数)
(C++11)(C++11)(C++11)
给定数值的以 2 为底的对数(log2(x)
(函数)
(C++11)(C++11)(C++11)
返回 e 的给定次幂减一(ex-1
(函数)