std::log2, std::log2f, std::log2l

来自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)
(C++11)
log2
(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       log2 ( float num );

double      log2 ( double num );

long double log2 ( long double num );
(C++11 起)
(C++23 前)
/* 浮点类型 */ log2( /* 浮点类型 */ num );
(C++23 起)
float       log2f( float num );
(2) (C++11 起)
long double log2l( long double num );
(3) (C++11 起)
在标头 <cmath> 定义
template< class Integer >
double      log2 ( Integer num );
(A) (C++11 起)
1-3) 计算 num 的底 2 对数。标准库提供所有以无 cv 限定的浮点类型作为参数 num 的类型的 std::log2 重载。 (C++23 起)
A) 为所有整数类型提供额外重载,将它们当做 double

参数

num - 浮点或整数值

返回值

如果没有发生错误,那么返回 num 的底 2 对数(log
2
(num)
lb(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。

注解

对于整数 num,二进制对数能转译成输入中最高位 1 的零底下标。

额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的整数类型实参 num 确保 std::log2(num)std::log2(static_cast<double>(num)) 的效果相同。

示例

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
#pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "log2(65536) = " << std::log2(65536) << '\n'
              << "log2(0.125) = " << std::log2(0.125) << '\n'
              << "log2(0x020f) = " << std::log2(0x020f)
              << "(已置的最高位在位置 9)\n"
              << "125 以 5 为底的对数 = " << std::log2(125)/std::log2(5) << '\n';
 
    // 特殊值
    std::cout << "log2(1) = " << std::log2(1) << '\n'
              << "log2(+Inf) = " << std::log2(INFINITY) << '\n';
 
    // 错误处理
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "log2(0) = " << std::log2(0) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    发生 FE_DIVBYZERO\n";
}

可能的输出:

log2(65536) = 16
log2(0.125) = -3
log2(0x020f) = 9.04166(已置的最高位在位置 9)
125 以 5 为底的对数 = 3
log2(1) = 0
log2(+Inf) = inf
log2(0) = -inf
    errno == ERANGE: Numerical result out of range
    发生 FE_DIVBYZERO

参阅

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