# log2

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           log2, log2f, log2l — compute base 2 logarithm functions
    


## SYNOPSIS



           #include <math.h>
    
           double log2(double _x_);
           float log2f(float _x_);
           long double log2l(long double _x_);
    


## DESCRIPTION



           The functionality described on this reference page is aligned with
           the ISO C standard. Any conflict between the requirements
           described here and the ISO C standard is unintentional. This
           volume of POSIX.1‐2017 defers to the ISO C standard.
    
           These functions shall compute the base 2 logarithm of their
           argument _x_ , log2(_x_).
    
           An application wishing to check for error situations should set
           _errno_ to zero and call _feclearexcept_(FE_ALL_EXCEPT) before calling
           these functions. On return, if _errno_ is non-zero or
           _fetestexcept_(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW |
           FE_UNDERFLOW) is non-zero, an error has occurred.
    


## RETURN VALUE



           Upon successful completion, these functions shall return the base
           2 logarithm of _x_.
    
           If _x_ is ±0, a pole error shall occur and _log2_(), _log2f_(), and
           _log2l_() shall return -HUGE_VAL, -HUGE_VALF, and -HUGE_VALL,
           respectively.
    
           For finite values of _x_ that are less than 0, or if _x_ is -Inf, a
           domain error shall occur, and either a NaN (if supported), or an
           implementation-defined value shall be returned.
    
           If _x_ is NaN, a NaN shall be returned.
    
           If _x_ is 1, +0 shall be returned.
    
           If _x_ is +Inf, _x_ shall be returned.
    


## ERRORS



           These functions shall fail if:
    
           Domain Error
                       The finite value of _x_ is less than zero, or _x_ is -Inf.
    
                       If the integer expression (_math_errhandling_ &
                       MATH_ERRNO) is non-zero, then _errno_ shall be set to
                       **[EDOM]**.  If the integer expression (_math_errhandling_ &
                       MATH_ERREXCEPT) is non-zero, then the invalid
                       floating-point exception shall be raised.
    
           Pole Error  The value of _x_ is zero.
    
                       If the integer expression (_math_errhandling_ &
                       MATH_ERRNO) is non-zero, then _errno_ shall be set to
                       **[ERANGE]**.  If the integer expression (_math_errhandling_
                       & MATH_ERREXCEPT) is non-zero, then the divide-by-zero
                       floating-point exception shall be raised.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           On error, the expressions (_math_errhandling_ & MATH_ERRNO) and
           (_math_errhandling_ & MATH_ERREXCEPT) are independent of each other,
           but at least one of them must be non-zero.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *