share/man/man3m/frexp.3m

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   4 .\" Copyright 1989 AT&T
   5 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   7 .\" http://www.opengroup.org/bookstore/.
   8 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   9 .\"  This notice shall appear on any product containing this material.
  10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  12 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  13 .TH FREXP 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  14 .SH NAME
  15 frexp, frexpf, frexpl \- extract mantissa and exponent from a floating-point
  16 number
  17 .SH SYNOPSIS
  18 .LP
  19 .nf
  20 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  21 #include <math.h>
  22
  23 \fBdouble\fR \fBfrexp\fR(\fBdouble\fR \fInum\fR, \fBint *\fR\fIexp\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBfloat\fR \fBfrexpf\fR(\fBfloat\fR \fInum\fR, \fBint *\fR\fIexp\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBlong double\fR \fBfrexpl\fR(\fBlong double\fR \fInum\fR, \fBint *\fR\fIexp\fR);
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 These functions break a floating-point number into a normalized fraction and an
  40 integral power of 2. They store the integer exponent in the \fBint\fR object
  41 pointed to by \fIexp\fR.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 For finite arguments, these functions return the value \fIx\fR, such that
  46 \fIx\fR is a \fBdouble\fR with magnitude in the interval [\(12, 1) or 0, and
  47 \fInum\fR equals \fIx\fR times 2 raised to the power *\fIexp\fR.
  48 .sp
  49 .LP
  50 If \fInum\fR is NaN, NaN is returned and the value of *\fIexp\fR is
  51 unspecified.
  52 .sp
  53 .LP
  54 If \fInum\fR is \(+- 0, \(+- 0 is returned and the value of *\fIexp\fR is 0.
  55 .sp
  56 .LP
  57 If \fInum\fR is \(+-Inf, \fInum\fR is returned and the value of *\fIexp\fR is
  58 unspecified.
  59 .SH ATTRIBUTES
  60 .sp
  61 .LP
  62 See \fBattributes\fR(5) for descriptions of the following attributes:
  63 .sp
  64
  65 .sp
  66 .TS
  67 tab(    ) box;
  68 cw(2.75i) |cw(2.75i)
  69 lw(2.75i) |lw(2.75i)
  70 .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 _
  73 Interface Stability     Standard
  74 _
  75 MT-Level        MT-Safe
  76 .TE
  77
  78 .SH SEE ALSO
  79 .sp
  80 .LP
  81 \fBisnan\fR(3M), \fBldexp\fR(3M), \fBmodf\fR(3M), \fBattributes\fR(5),
  82 \fBstandards\fR(5)