original/man3/frexp.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   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.
  12 .\"
  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.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  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 .\"
  33 .TH FREXP 3 2010-09-20 "" "Linux Programmer's Manual"
  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 );
  42 .br
  43 .BI "float frexpf(float " x ", int *" exp );
  44 .br
  45 .BI "long double frexpl(long double " x ", int *" exp );
  46 .fi
  47 .sp
  48 Link with \fI\-lm\fP.
  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 ():
  58 .RS 4
  59 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  60 _POSIX_C_SOURCE\ >=\ 200112L;
  61 .br
  62 or
  63 .I cc\ -std=c99
  64 .RE
  65 .ad
  66 .SH DESCRIPTION
  67 The
  68 .BR frexp ()
  69 function is used to split the number \fIx\fP into a
  70 normalized fraction and an exponent which is stored in \fIexp\fP.
  71 .SH RETURN VALUE
  72 The
  73 .BR frexp ()
  74 function returns the normalized fraction.
  75 If the argument \fIx\fP is not zero,
  76 the normalized fraction is \fIx\fP times a power of two,
  77 and its absolute value is always in the range 1/2 (inclusive) to
  78 1 (exclusive), that is, [0.5,1).
  79
  80 If \fIx\fP is zero, then the normalized fraction is
  81 zero and zero is stored in \fIexp\fP.
  82
  83 If
  84 .I x
  85 is a NaN,
  86 a NaN is returned, and the value of
  87 .I *exp
  88 is unspecified.
  89
  90 If
  91 .I x
  92 is positive infinity (negative infinity),
  93 positive infinity (negative infinity) is returned, and the value of
  94 .I *exp
  95 is unspecified.
  96 .SH ERRORS
  97 No errors occur.
  98 .SH CONFORMING TO
  99 C99, POSIX.1-2001.
 100 The variant returning
 101 .I double
 102 also conforms to
 103 SVr4, 4.3BSD, C89.
 104 .SH EXAMPLE
 105 The program below produces results such as the following:
 106 .sp
 107 .nf
 108 .in +4n
 109 .RB "$" " ./a.out 2560"
 110 frexp(2560, &e) = 0.625: 0.625 * 2^12 = 2560
 111 .RB "$" " ./a.out \-4"
 112 frexp(\-4, &e) = \-0.5: \-0.5 * 2^3 = \-4
 113 .in
 114 .fi
 115 .SS Program source
 116 \&
 117 .nf
 118 #include <math.h>
 119 #include <float.h>
 120 #include <stdio.h>
 121 #include <stdlib.h>
 122
 123 int
 124 main(int argc, char *argv[])
 125 {
 126     double x, r;
 127     int exp;
 128
 129     x = strtod(argv[1], NULL);
 130     r = frexp(x, &exp);
 131
 132     printf("frexp(%g, &e) = %g: %g * %d^%d = %g\\n",
 133            x, r, r, FLT_RADIX, exp, x);
 134     exit(EXIT_SUCCESS);
 135 }
 136 .fi
 137 .SH SEE ALSO
 138 .BR ldexp (3),
 139 .BR modf (3)