xref: /openbsd/lib/libc/gen/frexp.3 (revision df930be7)
1.\"	$NetBSD: frexp.3,v 1.3 1995/02/27 03:43:10 cgd Exp $
2.\"
3.\" Copyright (c) 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the American National Standards Committee X3, on Information
8.\" Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     @(#)frexp.3	8.1 (Berkeley) 6/4/93
39.\"
40.Dd June 4, 1993
41.Dt FREXP 3
42.Os
43.Sh NAME
44.Nm frexp
45.Nd convert floating-point number to fractional and integral components
46.Sh SYNOPSIS
47.Fd #include <math.h>
48.Ft double
49.Fn frexp "double value" "int *exp"
50.Sh DESCRIPTION
51The
52.Fn frexp
53function breaks a floating-point number into a normalized
54fraction and an integral power of 2.
55It stores the integer in the
56.Em int
57object pointed to by
58.Fa exp .
59.Sh RETURN VALUES
60The
61.Fn frexp
62function returns the value
63.Em x ,
64such that
65.Em x
66is a
67.Em double
68with magnitude in the interval
69.Bq 1/2 , 1
70or zero, and
71.Fa value
72equals
73.Em x
74times 2 raised to the power
75.Fa *exp .
76If
77.Fa value
78is zero, both parts of the result are zero.
79.Sh SEE ALSO
80.Xr ldexp 3 ,
81.Xr modf 3 ,
82.Xr math 3
83.Sh STANDARDS
84The
85.Fn frexp
86function conforms to
87.St -ansiC .
88