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

int ilogb ( float num );
int ilogb ( double num );
int ilogb ( long double num );

constexpr int ilogb( /* floating-point-type */ num );

int ilogbf( float num );

int ilogbl( long double num );

#define FP_ILOGB0   /* implementation-defined */

#define FP_ILOGBNAN /* implementation-defined */

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

Формально, несмещённый показатель — это целая часть log_r|num|, представленная знаковым целым значением, для ненулевого num, где r — это std::numeric_limits<T>::radix, а T — тип с плавающей точкой выражения num.

Параметры

Возвращаемое значение

Если ошибок не возникает, несмещённый показатель числа num возвращается в виде значения типа signed 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, всегда на 1 меньше показателя, возвращаемого std::frexp, из-за разных требований к нормализации: для показателя e, возвращаемого std::ilogb, |num*r^-e| находится между 1 и r (обычно между 1 и 2), тогда как для показателя e, возвращаемого std::frexp, |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 << "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

См. также