std::log2

Functions

Basic operations

abs(int)labsllabsimaxabs (C++11)
abs(float)fabs
divldivlldivimaxdiv (C++11)
fmod

remainder (C++11)
remquo (C++11)
fma (C++11)
fmax (C++11)
fmin (C++11)
fdim (C++11)
nannanfnanl (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

sin
cos
tan
asin
acos
atan
atan2

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
roundlroundllround (C++11)(C++11)(C++11)

trunc (C++11)
nearbyint (C++11)
rintlrintllrint (C++11)(C++11)(C++11)

Floating point manipulation functions

ldexp
scalbnscalbln (C++11)(C++11)
ilogb (C++11)
logb (C++11)

frexp
modf
nextafternexttoward (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

HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11)
INFINITY (C++11)
NAN (C++11)
math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)

FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN

(C++11)(C++11)(C++11)(C++11)(C++11)

Defined in header `<cmath>`
float log2( float arg );	(1)	(since C++11)
double log2( double arg );	(2)	(since C++11)
long double log2( long double arg );	(3)	(since C++11)
double log2( Integral arg );	(4)	(since C++11)

1-3) Computes the binary (base-2) logarithm of arg.

4) A set of overloads or a function template accepting an argument of any integral type. Equivalent to 2) (the argument is cast to double).

Parameters

arg

-

value of floating-point or Integral type

Return value

If no errors occur, the base-2 logarithm of arg ( $log 2 (arg)$ or $lb(arg)$ ) is returned.

If a domain error occurs, an implementation-defined value is returned (NaN where supported)

If a pole error occurs, -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL is returned.

Error handling

Errors are reported as specified in math_errhandling

Domain error occurs if arg is less than zero.

Pole error may occur if arg is zero.

If the implementation supports IEEE floating-point arithmetic (IEC 60559),

If the argument is ±0, -∞ is returned and FE_DIVBYZERO is raised.
If the argument is 1, +0 is returned
If the argument is negative, NaN is returned and FE_INVALID is raised.
If the argument is +∞, +∞ is returned
If the argument is NaN, NaN is returned

Notes

For integer arg, the binary logarithm can be interpreted as the zero-based index of the most significant 1 bit in the input.

Example

Run this code

#include <iostream>
#include <cmath>
#include <cerrno>
#include <cstring>
#include <cfenv>
#pragma STDC FENV_ACCESS ON
int main()
{
    std::cout << "log2(65536) = " << std::log2(65536) << '\n'
              << "log2(0.125) = " << std::log2(0.125) << '\n'
              << "log2(0x020f) = " << std::log2(0x020f)
              << " (highest set bit is in position 9)\n"
              << "base-5 logarithm of 125 = " << std::log2(125)/std::log2(5) << '\n';
    // special values
    std::cout << "log2(1) = " << std::log2(1) << '\n'
              << "log2(+Inf) = " << std::log2(INFINITY) << '\n';
    // error handling 
    errno=0; std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "log2(0) = " << std::log2(0) << '\n';
    if(errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if(std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

Possible output:

log2(65536) = 16
log2(0.125) = -3
log2(0x020f) = 9.04166 (highest set bit is in position 9)
base-5 logarithm of 125 = 3
log2(1) = 0
log2(+Inf) = inf
log2(0) = -inf
    errno == ERANGE: Numerical result out of range
    FE_DIVBYZERO raised

Language
Standard library headers
Concepts
Utilities library
Strings library
Containers library
Algorithms library
Iterators library
Numerics library
Input/output library
Localizations library
Regular expressions library (C++11)
Atomic operations library (C++11)
Thread support library (C++11)
Filesystem library (C++17)
Technical Specifications

Common mathematical functions
Special mathematical functions
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Compile-time rational arithmetic (C++11)
Numeric algorithms
gcd (C++17)
lcm (C++17)
Generic numeric operations
iota (C++11)
accumulate
inner_product
adjacent_difference
partial_sum