Ilogb

定义于头文件 <cmath> 中。

描述

从浮点参数num中提取无偏指数的值，并将其作为带符号的整数值返回。
库为所有不带 cv 限定符的浮点类型提供了 std::ilogb 的重载，作为参数 num 的类型（自 C++23 起）.

定义

• 4. 展开为整数常量表达式，其值为 INT_MIN 或 -INT_MAX。
• 5. 展开为整数常量表达式，其值为 INT_MIN 或 +INT_MAX。

​附加重载适用于所有整数类型，它们被视为双精度浮点数。

形式上，对于非零 num，无偏指数是 log_r|num| 的整数部分，作为一个有符号整数值，其中 r 是 std::numeric_limits<T>::radix，T 是 num 的浮点类型。

声明

C++23

// 1)
constexpr int ilogb( /* floating-point-type */ num );
// 2)
constexpr int ilogbf( float num );
// 3)
constexpr int ilogbl( long double num );

定义

// 4)
#define FP_ILOGB0   /* implementation-defined */
// 5)
#define FP_ILOGBNAN /* implementation-defined */

附加重载

// 6)
template< class Integer >
constexpr int ilogb ( Integer num );

C++11

// 1)
int ilogb ( float num );
// 2)
int ilogb ( double num );
// 3)
int ilogb ( long double num );
// 4)
int ilogbf( float num );
// 5)
int ilogbl( long double num );

定义

// 6)
#define FP_ILOGB0   /* implementation-defined */
// 7)
#define FP_ILOGBNAN /* implementation-defined */

附加重载

// 8)
template< class Integer >
int ilogb ( Integer num );

参数

​num - 浮点或整数值

返回值

如果没有发生错误，则将 num 的无偏指数作为有符号 int 值返回。

如果 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，则返回的值与 static_cast<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 之间。

不要求提供的附加重载与附加重载完全一致。它们只需足以确保对于整数类型的参数 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 
        << "Given the number " << f << " or " 
        << std::hexfloat << f << std::defaultfloat 
        << " in hex,\n";
 
    double f3;
    double f2 = std::modf(f, &f3);
    std::cout 
        << "modf() makes " 
        << f3 << " + " << f2 
        << '\n';
 
    int i;
    f2 = std::frexp(f, &i);
    std::cout 
        << "frexp() makes " 
        << f2 << " * 2^" << i 
        << '\n';
 
    i = std::ilogb(f);
    std::cout 
        << "logb()/ilogb() make " 
        << f / std::scalbn(1.0, i) << " * "
        << std::numeric_limits<double>::radix
        << "^" << std::ilogb(f) << '\n';
 
    // error handling
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout 
        << "ilogb(0) = " 
        << std::ilogb(0) << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout 
            << "FE_INVALID raised\n";
}

可能结果

Given the number 123.45 or 0x1.edccccccccccdp+6 in hex,
modf() makes 123 + 0.45
frexp() makes 0.964453 * 2^7
logb()/ilogb() make 1.92891 * 2^6
ilogb(0) = -2147483648
FE_INVALID raised