Namespaces
Variants

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

From cppreference.net
Common mathematical functions
Nearest integer floating point operations
(C++11)
(C++11)
(C++11) (C++11) (C++11)
Floating point manipulation functions
(C++11) (C++11)
(C++11)
(C++11)
Classification and comparison
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Types
(C++11)
(C++11)
(C++11)
Macro constants
定义于头文件 <cmath>
(1)
float log2 ( float num ) ;

double log2 ( double num ) ;

long double log2 ( long double num ) ;
(C++23 前)
/*floating-point-type*/
log2 ( /*floating-point-type*/ num ) ;
(C++23 起)
(C++26 起为 constexpr)
float log2f ( float num ) ;
(2) (C++11 起)
(C++26 起为 constexpr)
long double log2l ( long double num ) ;
(3) (C++11 起)
(C++26 起为 constexpr)
SIMD 重载 (C++26 起)
定义于头文件 <simd>
template < /*math-floating-point*/ V >

constexpr /*deduced-simd-t*/ < V >

log2 ( const V & v_num ) ;
(S) (C++26 起)
额外重载 (C++11 起)
定义于头文件 <cmath>
template < class Integer >
double log2 ( Integer num ) ;
(A) (C++26 起为 constexpr)
1-3) 计算 num 二进制(以 2 为底)对数 标准库为所有 cv 未限定浮点类型提供了 std::log2 的重载版本作为参数类型。 (C++23 起)
S) SIMD 重载对 v_num 执行逐元素的 std::log2 运算。
(定义参见 math-floating-point deduced-simd-t 。)
(since C++26)
A) 为所有整数类型提供了额外的重载,这些类型被视为 double
(since C++11)

目录

参数

num - 浮点数或整数值

返回值

如果未发生错误,则返回 num 的以 2 为底的对数( log 2 (num) lb(num) )。

如果发生定义域错误,将返回一个由实现定义的值(在支持 NaN 的情况下返回 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: 数值结果超出范围
    触发了 FE_DIVBYZERO 异常

参见

(C++11) (C++11)
计算自然(以 e 为底)对数( ln(x)
(函数)
(C++11) (C++11)
计算常用(以 10 为底)对数( log 10 (x)
(函数)
(C++11) (C++11) (C++11)
计算给定数值加 1 后的自然对数(以 e 为底)( ln(1+x)
(函数)
(C++11) (C++11) (C++11)
返回 2 的给定次幂( 2 x
(函数)
C 文档 关于 log2