std::frexp, std::frexpf, std::frexpl
Defined in header <cmath> | ||
|---|---|---|
| (1) | ||
float frexp ( float arg, int* exp ); | ||
float frexpf( float arg, int* exp ); | (since C++11) | |
double frexp ( double arg, int* exp ); | (2) | |
| (3) | ||
long double frexp ( long double arg, int* exp ); | ||
long double frexpl( long double arg, int* exp ); | (since C++11) | |
double frexp ( IntegralType arg, int* exp ); | (4) | (since C++11) |
arg into a normalized fraction and an integral power of two. double).Parameters
| arg | - | floating point value |
| exp | - | pointer to integer value to store the exponent to |
Return value
If arg is zero, returns zero and stores zero in *exp.
Otherwise (if arg is not zero), if no errors occur, returns the value x in the range (-1;-0.5], [0.5; 1) and stores an integer value in *exp such that x×2(*exp)
=arg.
If the value to be stored in *exp is outside the range of int, the behavior is unspecified.
If arg is not a floating-point number, the behavior is unspecified.
Error handling
This function is not subject to any errors specified in math_errhandling.
If the implementation supports IEEE floating-point arithmetic (IEC 60559),
- If
argis ±0, it is returned, unmodified, and0is stored in*exp. - If
argis ±∞, it is returned, and an unspecified value is stored in*exp. - If
argis NaN, NaN is returned, and an unspecified value is stored in*exp. - No floating-point exceptions are raised.
- If
FLT_RADIXis 2 (or a power of 2), the returned value is exact, the current rounding mode is ignored
Notes
On a binary system (where FLT_RADIX is 2), frexp may be implemented as.
{
*exp = (value == 0) ? 0 : (int)(1 + std::logb(value));
return std::scalbn(value, -(*exp));
}The function std::frexp, together with its dual, std::ldexp, can be used to manipulate the representation of a floating-point number without direct bit manipulations.
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';
}Possible 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
See also
|
(C++11)(C++11) | multiplies a number by 2 raised to a power (function) |
|
(C++11)(C++11)(C++11) | extracts exponent of the number (function) |
|
(C++11)(C++11)(C++11) | extracts exponent of the number (function) |
|
(C++11)(C++11) | decomposes a number into integer and fractional parts (function) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://en.cppreference.com/w/cpp/numeric/math/frexp