]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) |
2 | .\" | |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
4 | .\" Permission is granted to make and distribute verbatim copies of this |
5 | .\" manual provided the copyright notice and this permission notice are | |
6 | .\" preserved on all copies. | |
7 | .\" | |
8 | .\" Permission is granted to copy and distribute modified versions of this | |
9 | .\" manual under the conditions for verbatim copying, provided that the | |
10 | .\" entire resulting derived work is distributed under the terms of a | |
11 | .\" permission notice identical to this one. | |
c13182ef | 12 | .\" |
fea681da MK |
13 | .\" Since the Linux kernel and libraries are constantly changing, this |
14 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
15 | .\" responsibility for errors or omissions, or for damages resulting from | |
16 | .\" the use of the information contained herein. The author(s) may not | |
17 | .\" have taken the same level of care in the production of this manual, | |
18 | .\" which is licensed free of charge, as they might when working | |
19 | .\" professionally. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
fea681da MK |
24 | .\" |
25 | .\" References consulted: | |
26 | .\" Linux libc source code | |
27 | .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) | |
28 | .\" 386BSD man pages | |
29 | .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu) | |
30 | .\" Modified 2002-07-27 by Walter Harms | |
31 | .\" (walter.harms@informatik.uni-oldenburg.de) | |
32 | .\" | |
97986708 | 33 | .TH FREXP 3 2016-03-15 "" "Linux Programmer's Manual" |
fea681da MK |
34 | .SH NAME |
35 | frexp, frexpf, frexpl \- convert floating-point number to fractional | |
36 | and integral components | |
37 | .SH SYNOPSIS | |
38 | .nf | |
39 | .B #include <math.h> | |
40 | .sp | |
41 | .BI "double frexp(double " x ", int *" exp ); | |
d39541ec | 42 | .br |
fea681da | 43 | .BI "float frexpf(float " x ", int *" exp ); |
d39541ec | 44 | .br |
fea681da MK |
45 | .BI "long double frexpl(long double " x ", int *" exp ); |
46 | .fi | |
47 | .sp | |
20c58d70 | 48 | Link with \fI\-lm\fP. |
6717c6ea MK |
49 | .sp |
50 | .in -4n | |
51 | Feature Test Macro Requirements for glibc (see | |
52 | .BR feature_test_macros (7)): | |
53 | .in | |
54 | .sp | |
55 | .ad l | |
56 | .BR frexpf (), | |
57 | .BR frexpl (): | |
b90c43a8 | 58 | .RS 4 |
e9d91bcf MK |
59 | _ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L |
60 | || /* Since glibc 2.19: */ _DEFAULT_SOURCE | |
61 | || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE | |
b90c43a8 MK |
62 | .RE |
63 | .ad | |
fea681da | 64 | .SH DESCRIPTION |
5600f73a | 65 | These functions are used to split the number |
022671eb MK |
66 | .I x |
67 | into a | |
68 | normalized fraction and an exponent which is stored in | |
69 | .IR exp . | |
47297adb | 70 | .SH RETURN VALUE |
5600f73a | 71 | These functions return the normalized fraction. |
022671eb MK |
72 | If the argument |
73 | .I x | |
74 | is not zero, | |
75 | the normalized fraction is | |
76 | .I x | |
77 | times a power of two, | |
a2af275c | 78 | and its absolute value is always in the range 1/2 (inclusive) to |
6717c6ea MK |
79 | 1 (exclusive), that is, [0.5,1). |
80 | ||
022671eb MK |
81 | If |
82 | .I x | |
83 | is zero, then the normalized fraction is | |
84 | zero and zero is stored in | |
85 | .IR exp . | |
6717c6ea MK |
86 | |
87 | If | |
88 | .I x | |
89 | is a NaN, | |
90 | a NaN is returned, and the value of | |
91 | .I *exp | |
92 | is unspecified. | |
93 | ||
94 | If | |
95 | .I x | |
96 | is positive infinity (negative infinity), | |
97 | positive infinity (negative infinity) is returned, and the value of | |
98 | .I *exp | |
99 | is unspecified. | |
100 | .SH ERRORS | |
101 | No errors occur. | |
7e9ee9a4 | 102 | .SH ATTRIBUTES |
a49c5865 MK |
103 | For an explanation of the terms used in this section, see |
104 | .BR attributes (7). | |
105 | .TS | |
106 | allbox; | |
107 | lbw27 lb lb | |
108 | l l l. | |
109 | Interface Attribute Value | |
110 | T{ | |
7e9ee9a4 PH |
111 | .BR frexp (), |
112 | .BR frexpf (), | |
7e9ee9a4 | 113 | .BR frexpl () |
a49c5865 MK |
114 | T} Thread safety MT-Safe |
115 | .TE | |
47297adb | 116 | .SH CONFORMING TO |
9a74e018 | 117 | C99, POSIX.1-2001, POSIX.1-2008. |
e05e3635 | 118 | |
6717c6ea MK |
119 | The variant returning |
120 | .I double | |
121 | also conforms to | |
122 | SVr4, 4.3BSD, C89. | |
fea681da | 123 | .SH EXAMPLE |
a831ef97 MK |
124 | The program below produces results such as the following: |
125 | .sp | |
126 | .nf | |
127 | .in +4n | |
128 | .RB "$" " ./a.out 2560" | |
129 | frexp(2560, &e) = 0.625: 0.625 * 2^12 = 2560 | |
130 | .RB "$" " ./a.out \-4" | |
c3074d70 | 131 | frexp(\-4, &e) = \-0.5: \-0.5 * 2^3 = \-4 |
a831ef97 MK |
132 | .in |
133 | .fi | |
134 | .SS Program source | |
d84d0300 | 135 | \& |
fea681da | 136 | .nf |
fea681da MK |
137 | #include <math.h> |
138 | #include <float.h> | |
a2af275c MK |
139 | #include <stdio.h> |
140 | #include <stdlib.h> | |
141 | ||
142 | int | |
143 | main(int argc, char *argv[]) | |
144 | { | |
145 | double x, r; | |
146 | int exp; | |
147 | ||
148 | x = strtod(argv[1], NULL); | |
149 | r = frexp(x, &exp); | |
150 | ||
39ad75ab | 151 | printf("frexp(%g, &e) = %g: %g * %d^%d = %g\\n", |
7295b7ed | 152 | x, r, r, FLT_RADIX, exp, x); |
a2af275c | 153 | exit(EXIT_SUCCESS); |
c54ed37e | 154 | } |
fea681da | 155 | .fi |
47297adb | 156 | .SH SEE ALSO |
fea681da MK |
157 | .BR ldexp (3), |
158 | .BR modf (3) |