std::logb, std::logbf, std::logbl

float       logb ( float num );
double      logb ( double num );
long double logb ( long double num );

constexpr /*floating-point-type*/
            logb ( /*floating-point-type*/ num );

float       logbf( float num );

long double logbl( long double num );

template< /*math-floating-point*/ V >
constexpr /*deduced-simd-t*/<V> 
            logb ( const V& v_num );

template< class Integer >
double      logb ( Integer num );

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

Параметры

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

Если ошибок не возникает, несмещённый показатель степени num возвращается в виде значения с плавающей точкой со знаком.

В случае ошибки области определения возвращается значение, определяемое реализацией.

В случае ошибки полюса возвращается -HUGE_VAL, -HUGE_VALF или -HUGE_VALL.

Обработка ошибок

Об ошибках сообщается согласно спецификации math_errhandling.

Если num равно нулю, может возникнуть ошибка области определения или диапазона.

Если реализация поддерживает арифметику с плавающей точкой IEEE (IEC 60559),

• Если num равно ±0, возвращается -∞ и устанавливается FE_DIVBYZERO.
• Если num равно ±∞, возвращается +∞.
• Если num является NaN, возвращается NaN.
• Во всех остальных случаях результат точен (FE_INEXACT никогда не устанавливается), а текущий режим округления игнорируется.

Примечания

POSIX требует, чтобы при num, равном ±0, возникала ошибка полюса.

Значение показателя степени, возвращаемое std::logb, всегда на 1 меньше значения показателя степени, возвращаемого std::frexp, из-за разных требований к нормализации: для показателя степени e, возвращаемого std::logb, |num*r^-e| находится в диапазоне от 1 до r (обычно от 1 до 2), тогда как для показателя степени e, возвращаемого std::frexp, |num*2^-e| находится в диапазоне от 0.5 до 1.

Дополнительные перегрузки не обязательно должны быть предоставлены точно в виде (A). Они должны лишь обеспечивать, чтобы для аргумента num целочисленного типа std::logb(num) имело тот же эффект, что и std::logb(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 << "logb(0) = " << std::logb(0) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO 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
logb(0) = -Inf
    FE_DIVBYZERO raised

См. также