std::ilogb, std::ilogbf, std::ilogbl

来自cppreference.com
 
C++
 
数值库
 
常用数学函数
函数
基础运算
(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)
(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) 
int ilogb ( float num );
int ilogb ( double num );
int ilogb ( long double num );
(C++11 起)
(C++23 前)		 
constexpr int ilogb( /* floating-point-type */ num );
(C++23 起) 
int ilogbf( float num );
(2) (C++11 起)
(C++23 起为 constexpr) 
int ilogbl( long double num );
(3) (C++11 起)
(C++23 起为 constexpr) 
#define FP_ILOGB0   /* 由实现定义 */
(4) (C++11 起) 
#define FP_ILOGBNAN /* 由实现定义 */
(5) (C++11 起)
在标头 <cmath> 定义 
template< class Integer >
int ilogb ( Integer num );
(A) (C++11 起)
(C++23 起为 constexpr)
1-3) 从浮点数实参 num 提取独立于基底的无偏指数，并将它作为有符号整数返回。标准库提供所有以无 cv 限定的浮点数类型作为实参 num 的类型的 std::ilogb 重载。(C++23 起)
4) 展开成整数常量表达式，值为 INT_MIN 或 -INT_MAX。
5) 展开成整数常量表达式，值为 INT_MIN 或 +INT_MAX。
A) 为所有整数类型提供额外重载，将它们当做 double。

正式而言，无偏指数是非零 num 的 logr|num| 作为有符号整数的整数部分，其中 r 是 std::numeric_limits<T>::radix，而 T 是 num 的浮点数类型。

参数

num - 浮点数或整数

返回值

如果没有发生错误，那么返回作为有符号整数的 num 的无偏指数。

如果 num 为零，那么返回 FP_ILOGB0。

如果 num 是无穷大，那么返回 INT_MAX。

如果 num 是 NaN，那么返回 FP_ILOGBNAN。

如果正确结果大于 INT_MAX 或小于 INT_MIN，那么返回值未指定，并且可能出现定义域或值域错误。

错误处理

报告 math_errhandling 中指定的错误。

如果 num 是零、无穷大或 NaN，那么可能出现定义域错误或值域错误。

如果正确结果大于 INT_MAX 或小于 INT_MIN ，则可能出现定义域错误或值域错误。

如果实现支持 IEEE 浮点数算术（IEC 60559），那么

  • 如果正确结果大于 INT_MAX 或小于 INT_MIN，那么引发 FE_INVALID。
  • 如果 num 是 ±0、±∞ 或 NaN，那么引发 FE_INVALID。
  • 所有其他情况下，结果是准确的（决不引发 FE_INEXACT）并且忽略当前舍入模式。

注解

如果 num 不是零、无穷大或 NaN，那么返回的值准确等价于 (int)std::logb(num)。

POSIX 要求在 num 是零、无穷大、NaN 或正确结果在 int 的范围外时发生定义域错误。

POSIX 也要求在符合 XSI 的系统上，在正确结果大于 INT_MAX 时返回 INT_MAX，而在正确结果小于 INT_MIN 时返回 INT_MIN。

在所有已知平台上正确结果都能表示成 int。对于要出现溢出的情况，INT_MAX 必须小于 LDBL_MAX_EXP * std::log2(FLT_RADIX) 或 INT_MIN 必须大于 (LDBL_MIN_EXP - LDBL_MANT_DIG) * std::log2(FLT_RADIX)。

std::ilogb 所返回的指数值始终比 std::frexp 所返回的小 1，因为正规化要求不同：对于 std::ilogb 返回的指数 e，|num*r-e
| 在 1 和 r 之间（典型地在 1 和 2 之间），但对于 std::frexp 返回的指数 e，|num*2-e
| 在 0.5 和 1 之间。

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

示例

比较不同的浮点数分解函数：

运行此代码
#include <cfenv>
#include <cmath>
#include <iostream>
#include <limits>
 
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    double f = 123.45;
    std::cout << "给定数字 " << f << "（十六进制表示为 " << std::hexfloat
              << f << std::defaultfloat << "），\n";

    double f3;
    double f2 = std::modf(f, &f3);
    std::cout << "modf() 会把它拆分成 " << f3 << " + " << f2 << '\n';

    int i;
    f2 = std::frexp(f, &i);
    std::cout << "frexp() 会把它拆分成 " << f2 << " * 2^" << i << '\n';

    i = std::ilogb(f);
    std::cout << "logb()/ilogb() 会把它拆分成 " << f / std::scalbn(1.0, i) << " * "
              << std::numeric_limits<double>::radix
              << "^" << std::ilogb(f) << '\n';

    // 错误处理
    std::feclearexcept(FE_ALL_EXCEPT);
    
    std::cout << "ilogb(0) = " << std::ilogb(0) << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout << "    发生 FE_INVALID\n";
}

可能的输出： 

给定数字 123.45（十六进制表示为 0x1.edccccccccccdp+6），
modf() 会把它拆分成 123 + 0.45
frexp() 会把它拆分成 0.964453 * 2^7
logb()/ilogb() 会把它拆分成 1.92891 * 2^6
ilogb(0) = -2147483648
    发生 FE_INVALID

参阅

(C++11)(C++11)
 将数分解为有效数字和以 2 为底的指数
(函数) [编辑]
(C++11)(C++11)(C++11)
 提取数的指数
(函数) [编辑]
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
 将数乘以 FLT_RADIX 的幂次
(函数) [编辑]
ilogb 的 C 文档