LOG2(3) Library Functions Manual LOG2(3)

log2 log2f log2l — compute base 2 logarithm functions

#include <math.h>

double log2(double x);
float log2f(float x);
long double log2l(long double x);

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 IEEE Std 1003.1-2001 (“POSIX.1”) 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 (FE_ALL_EXCEPT) before calling these functions. On return, if errno is non-zero or (FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.

Upon successful completion, these functions shall return the base 2 logarithm of x.

If x is ±0, a pole error shall occur and log2 (), (), and () shall return -HUGE_VAL, -HUGE_VALF, and -HUGE_VALL, respectively.

For finite values of x that are less than 0, [MX] or if x is -Inf, a domain error shall occur, and [MX] either a NaN (if supported), or an implementation-defined value shall be returned.

[MX] 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.

These functions shall fail if:

The finite value of x is less than zero, [MX] 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.

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.

None.

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.

None.

None.

feclearexcept(3), fetestexcept(3), log(3), the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), xbd_chap04(7), <math.h>

First released in Issue 6. Derived from the ISO/IEC 9899:1999 (“ISO C99”) standard.

footer end

January 1, 2004 posix.fail