std::ilogb

From cppreference.com
 
 
 
Common mathematical functions
Functions
Basic operations
remainder (C++11)
remquo (C++11)
fma (C++11)
fmax (C++11)
fmin (C++11)
fdim (C++11)
nan
nanf
nanl
(C++11)
(C++11)
(C++11)
Exponential functions
exp
exp2 (C++11)
expm1 (C++11)
log
log10
log1p (C++11)
log2 (C++11)
Power functions
sqrt
cbrt (C++11)
hypot (C++11)
pow
Trigonometric and hyperbolic functions
sinh
cosh
tanh
asinh (C++11)
acosh (C++11)
atanh (C++11)
Error and gamma functions
erf (C++11)
erfc (C++11)
lgamma (C++11)
tgamma (C++11)
Nearest integer floating point operations
ceil
floor
round
lround
llround
(C++11)
(C++11)
(C++11)
trunc (C++11)
nearbyint (C++11)
rint
lrint
llrint
(C++11)
(C++11)
(C++11)
Floating point manipulation functions
ldexp
scalbn
scalbln
(C++11)
(C++11)
ilogb (C++11)
logb (C++11)
frexp
modf
nextafter
nexttoward
(C++11)
(C++11)
copysign (C++11)
Classification/Comparison
fpclassify (C++11)
isfinite (C++11)
isinf (C++11)
isnan (C++11)
isnormal (C++11)
signbit (C++11)
isgreater (C++11)
isgreaterequal (C++11)
isless (C++11)
islessequal (C++11)
islessgreater (C++11)
isunordered (C++11)
Macro constants
FP_NORMAL
FP_SUBNORMAL
FP_ZERO
FP_INFINITE
FP_NAN
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
Defined in header <cmath>
int         ilogb( float arg );
(since C++11)
int         ilogb( double arg );
(since C++11)
int         ilogb( long double arg );
(since C++11)
double      ilogb( Integral arg );
(since C++11)
#define FP_ILOGB0 /*implementation-defined*/
(since C++11)
#define FP_ILOGBNAN /*implementation-defined*/
(since C++11)

Extracts the value of the exponent from the floating-point argument arg, and returns it as a signed integer value. Formally, the result is the integral part of log
r
|arg|
as a signed integral value, for non-zero arg, where r is std::numeric_limits<T>::radix and T is the floating-point type of arg.

Contents

[edit] Parameters

arg - floating point value

[edit] Return value

The floating-point exponent, cast to integer, as if by static_cast<int>(std::logb(arg)).

Domain or range error may occur if arg is zero, FP_ILOGB0 is returned in that case.

Domain or range error may occur if arg is infinite, MAX_INT is returned in that case.

Domain or range error may occur if arg is NaN, FP_ILOGBNAN is returned in that case.

If the result cannot be represented as int, the result is undefined.

[edit] Notes

The value of the exponent returned by std::ilogb is always 1 less than the exponent retuned by std::frexp because of the different normalization requirements: for the exponent e returned by std::ilogb, |arg*r-e
|
is between 1 and r (typically between 1 and 2), but for the exponent e returned by std::frexp, |arg*2-e
|
is between 0.5 and 1.

[edit] Example

Compares different floating-point decomposition functions

#include <iostream>
#include <cmath>
#include <limits>
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';
}

Output:

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

[edit] See also

decomposes a number into significand and a power of 2
(function)
(C++11)
extracts exponent of the number
(function)
(C++11)
(C++11)
multiplies a number by FLT_RADIX raised to a power
(function)