IEEE Std 1003.1-2017 (Revision of IEEE Std 1003.1-2008)

Copyright © 2001-2018 IEEE and The Open Group

ldexp, ldexpf, ldexpl - load exponent of a floating-point number

#include <math.h>

double ldexp(doublex, intexp);

float ldexpf(floatx, intexp);

long double ldexpl(long doublex, intexp);

^{[CX]}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 quantity

x* 2^{exp}.An application wishing to check for error situations should set

errnoto zero and callfeclearexcept(FE_ALL_EXCEPT) before calling these functions. On return, iferrnois non-zero orfetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.

Upon successful completion, these functions shall return

xmultiplied by 2, raised to the powerexp.If these functions would cause overflow, a range error shall occur and

ldexp(),ldexpf(), andldexpl() shall return ±HUGE_VAL, ±HUGE_VALF, and ±HUGE_VALL (according to the sign ofx), respectively.If the correct value would cause underflow,

^{[MXX]}and is not representable, a range error may occur, andldexp(),ldexpf(), andldexpl() shall return^{[MXX]}0.0, or (if IEC 60559 Floating-Point is not supported) an implementation-defined value no greater in magnitude than DBL_MIN, FLT_MIN, and LDBL_MIN, respectively.

^{[MX]}Ifxis NaN, a NaN shall be returned.If

xis ±0 or ±Inf,xshall be returned.If

expis 0,xshall be returned.

^{[MXX]}If the correct value would cause underflow, and is representable, a range error may occur and the correct value shall be returned.

These functions shall fail if:

- Range Error
- The result overflows.
If the integer expression (

math_errhandling& MATH_ERRNO) is non-zero, thenerrnoshall be set to [ERANGE]. If the integer expression (math_errhandling& MATH_ERREXCEPT) is non-zero, then the overflow floating-point exception shall be raised.These functions may fail if:

- Range Error
- The result underflows.
If the integer expression (

math_errhandling& MATH_ERRNO) is non-zero, thenerrnoshall be set to [ERANGE]. If the integer expression (math_errhandling& MATH_ERREXCEPT) is non-zero, then the underflow 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,fetestexcept,frexp,isnanXBD

Treatment of Error Conditions for Mathematical Functions,<math.h>

First released in Issue 1. Derived from Issue 1 of the SVID.

The DESCRIPTION is updated to indicate how an application should check for an error. This text was previously published in the APPLICATION USAGE section.

The

ldexpf() andldexpl() functions are added for alignment with the ISO/IEC 9899:1999 standard.The DESCRIPTION, RETURN VALUE, ERRORS, and APPLICATION USAGE sections are revised to align with the ISO/IEC 9899:1999 standard.

IEC 60559:1989 standard floating-point extensions over the ISO/IEC 9899:1999 standard are marked.

POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0352 [68] and XSH/TC1-2008/0353 [68] are applied.

return to top of page

POSIX ™ is a Trademark of The IEEE.

Copyright © 2001-2018 IEEE and The Open Group, All Rights Reserved

[ Main Index | XBD | XSH | XCU | XRAT ]