Log2

定义于头文件 <cmath> 中。

描述

计算 `num` 的二进制（以 2 为底）对数。该库为所有 cv-unqualified 浮点类型提供了 `std::log2` 的重载，作为参数 `num` 的类型。

声明

C++23

// 1)
/* floating-point-type */ log2( /* floating-point-type */ num );
// 2)
float log2f( float num );
// 3)
long double log2l( long double num );

附加重载

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

C++11

// 1)
float log2 ( float num );
// 2)
double log2 ( double num );
// 3)
long double log2 ( long double num );
// 4)
float log2f( float num );
// 5)
long double log2l( long double num );

附加重载

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

参数

`num` - 浮点或整数值

返回值

如果没有错误发生，则返回 `num` 的以 2 为底的对数 (log ₂(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`，二进制对数可以解释为输入中最高有效位的零基索引。

不需要完全按照附加重载提供附加重载。它们只需要足以确保对于其整数类型参数 num，`std::log2(num)` 与 `std::log2(static_cast<double>(num))` 具有相同的效果。

示例

#include <cerrno>
#include <cfenv>
#include <cstring>
#include <cmath>
#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)
        << " (highest set bit is in position 9)\n"
        << "base-5 logarithm of 125 = " 
        << std::log2(125)/std::log2(5) << '\n';
 
    // special values
    std::cout 
        << "log2(1) = " 
        << std::log2(1) << '\n'
        << "log2(+Inf) = " 
        << std::log2(INFINITY) << '\n';
 
    // error handling
    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 raised\n";
}

可能结果

log2(65536) = 16
log2(0.125) = -3
log2(0x020f) = 9.04166 (highest set bit is in position 9)
base-5 logarithm of 125 = 3
log2(1) = 0
log2(+Inf) = inf
log2(0) = -inf
errno == ERANGE: Numerical result out of range
FE_DIVBYZERO raised