freebsd-dev/lib/libc/gen/frexp.3

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)frexp.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd March 4, 2005
.Dt FREXP 3
.Os
.Sh NAME
.Nm frexp ,
.Nm frexpf ,
.Nm frexpl
.Nd convert floating-point number to fractional and integral components
.Sh LIBRARY
.Lb libm
.Sh SYNOPSIS
.In math.h
.Ft double
.Fn frexp "double value" "int *exp"
.Ft float
.Fn frexpf "float value" "int *exp"
.Ft long double
.Fn frexpl "long double value" "int *exp"
.Sh DESCRIPTION
The
.Fn frexp ,
.Fn frexpf
and
.Fn frexpl
functions break a floating-point number into a normalized
fraction and an integral power of 2.
They store the integer in the
.Vt int
object pointed to by
.Fa exp .
.Sh RETURN VALUES
These functions return the value
.Va x ,
such that
.Va x
is a
.Vt double
with magnitude in the interval
.Eo [ 1/2 , 1 Ec )
or zero, and
.Fa value
equals
.Va x
times 2 raised to the power
.Fa *exp .
If
.Fa value
is zero, both parts of the result are zero.
.Sh SEE ALSO
.Xr ldexp 3 ,
.Xr math 3 ,
.Xr modf 3
.Sh STANDARDS
The
.Fn frexp ,
.Fn frexpf ,
and
.Fn frexpl
functions conform to
.St -isoC-99 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the American National Standards Committee X3, on Information`
			`.\" Processing Systems.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)frexp.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Dd March 4, 2005`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt FREXP 3`
			`.Os`
			`.Sh NAME`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Nm frexp ,`
			`.Nm frexpf ,`
			`.Nm frexpl`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Nd convert floating-point number to fractional and integral components`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`.Lb libm`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In math.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft double`
			`.Fn frexp "double value" "int *exp"`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Ft float`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`.Fn frexpf "float value" "int *exp"`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Ft long double`
			`.Fn frexpl "long double value" "int *exp"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Fn frexp ,`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`.Fn frexpf`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`and`
			`.Fn frexpl`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`functions break a floating-point number into a normalized`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`fraction and an integral power of 2.`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`They store the integer in the`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Vt int`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`object pointed to by`
			`.Fa exp .`
			`.Sh RETURN VALUES`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`These functions return the value`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Va x ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`such that`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Va x`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`is a`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Vt double`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`with magnitude in the interval`
mdoc: don't abuse Bo/Pc to get what looks like an interval Be explicit and use the general bracketing form plus symbols which are to be interpreted mathematically in this case. Complaint by: mdocml Reviewed by: ru Approved by: philip, ed (mentors) 2010-04-14 18:29:34 +00:00			`.Eo [ 1/2 , 1 Ec )`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`or zero, and`
			`.Fa value`
			`equals`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Va x`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`times 2 raised to the power`
			`.Fa *exp .`
			`If`
			`.Fa value`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`is zero, both parts of the result are zero.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr ldexp 3 ,`
Sort cross references. 1997-01-20 23:23:22 +00:00			`.Xr math 3 ,`
			`.Xr modf 3`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh STANDARDS`
			`The`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Fn frexp ,`
			`.Fn frexpf ,`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`and`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Fn frexpl`
- Document frexpf(). - Neither frexp() nor frexpf() set errno. - Although frexp() is in libc for backwards compatibility, frexpf() is in its proper place in libm. Document both as being in libm. - The frexp() and frexpf() functions conform to C99. 2005-01-23 16:49:40 +00:00			`functions conform to`
			`.St -isoC-99 .`