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

形式的には、バイアスされていない指数は、非ゼロの arg について、符号付き整数値としての log
r|arg| の整数部です。 ただし r は std::numeric_limits<T>::radix で、 T は arg の浮動小数点型です。

[編集] 引数

[編集] 戻り値

エラーが発生しなければ、 arg のバイアスされていない指数が符号付き整数値として返されます。

arg がゼロの場合は、 FP_ILOGB0 が返されます。

arg が無限大の場合は、 INT_MAX が返されます。

arg が NaN の場合は、 FP_ILOGBNAN が返されます。

正しい結果が INT_MAX より大きいまたは INT_MIN より小さい場合、戻り値は未規定です。

[編集] エラー処理

math_errhandling で規定されている通りにエラーが報告されます。

arg がゼロ、無限大、または NaN の場合、定義域エラーまたは値域エラーが発生するかもしれません。

正しい結果が INT_MAX より大きいまたは INT_MIN より小さい場合、定義域エラーまたは値域エラーが発生するかもしれません。

処理系が IEEE 浮動小数点算術 (IEC 60559) をサポートしていれば、

• 正しい結果が INT_MAX より大きいまたは INT_MIN より小さい場合、 FE_INVALID が発生します。
• arg が ±0、 ±∞ または NaN の場合、 FE_INVALID が発生します。
• それ以外の全ての場合において、結果は正確であり (FE_INEXACT が発生することはありません)、現在の丸めモードは無視されます。

[編集] ノート

arg がゼロ、無限大または NaN でない場合、戻り値は static_cast<int>(std::logb(arg)) と正確に同等です。

POSIX は、 arg がゼロ、無限大、 NaN の場合、または正しい結果が int の範囲外の場合、定義域エラーが発生することを要求しています。

POSIX はまた、 XSI 準拠のシステムでは、正しい結果が INT_MAX より大きいとき、戻り値が INT_MAX であり、正しい結果が INT_MIN より小さいとき、戻り値が INT_MIN であることも要求しています。

すべての既知の実装において、正しい結果は int として表現可能です。 オーバーフローが発生するためには、 INT_MAX が LDBL_MAX_EXP*log2(FLT_RADIX) より小さいか、 INT_MIN が LDBL_MIN_EXP-LDBL_MANT_DIG)*log2(FLT_RADIX) より��きくなければなりません。

std::ilogb によって返される指数の値は、 std::frexp によって返される指数の値より常に 1 小さくなります。 これは正規化の要件が異なるためです。 std::ilogb によって返される指数 e の場合、 |arg*r-e
| は 1 と r (一般的には 1 と 2) の間になりますが、 std::frexp によって返される指数 e の場合、 |arg*2-e
| は 0.5 と 1 の間になります。

[編集] 例

#include <iostream>
#include <cmath>
#include <limits>
#include <cfenv>
 
#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';
 
    // エラー処理
    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

[編集] 関連項目