freebsd-dev/lib/libc/gen/ldexp.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.
.\"
.\"     @(#)ldexp.3	8.2 (Berkeley) 4/19/94
.\" $FreeBSD$
.\"
.Dd March 4, 2005
.Dt LDEXP 3
.Os
.Sh NAME
.Nm ldexp ,
.Nm ldexpf ,
.Nm ldexpl
.Nd multiply floating-point number by integral power of 2
.Sh LIBRARY
.Lb libm
.Sh SYNOPSIS
.In math.h
.Ft double
.Fn ldexp "double x" "int exp"
.Ft float
.Fn ldexpf "float x" "int exp"
.Ft long double
.Fn ldexpl "long double x" "int exp"
.Sh DESCRIPTION
The
.Fn ldexp ,
.Fn ldexpf ,
and
.Fn ldexpl
functions multiply a floating-point number by an integral
power of 2.
.Sh RETURN VALUES
These functions return the value of
.Fa x
times 2 raised to the power
.Fa exp .
.Sh SEE ALSO
.Xr frexp 3 ,
.Xr math 3 ,
.Xr modf 3
.Sh STANDARDS
The
.Fn ldexp ,
.Fn ldexpf ,
and
.Fn ldexpl
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.`
			`.\"`
			`.\" @(#)ldexp.3 8.2 (Berkeley) 4/19/94`
$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 LDEXP 3`
			`.Os`
			`.Sh NAME`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Nm ldexp ,`
			`.Nm ldexpf ,`
			`.Nm ldexpl`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Nd multiply floating-point number by integral power of 2`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +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 ldexp "double x" "int exp"`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +00:00			`.Ft float`
			`.Fn ldexpf "float x" "int exp"`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Ft long double`
			`.Fn ldexpl "long double x" "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 ldexp ,`
			`.Fn ldexpf ,`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +00:00			`and`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Fn ldexpl`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +00:00			`functions multiply a floating-point number by an integral`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`power of 2.`
			`.Sh RETURN VALUES`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +00:00			`These functions return the value of`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fa x`
			`times 2 raised to the power`
			`.Fa exp .`
			`.Sh SEE ALSO`
			`.Xr frexp 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 ldexp ,`
			`.Fn ldexpf ,`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +00:00			`and`
Document frexpl and ldexpl. 2005-03-07 05:00:54 +00:00			`.Fn ldexpl`
- Document ldexpf(). - Although ldexp() is in libc for backwards compatibility, ldexpf() is in its proper place in libm. Document both as being in libm. - The ldexp() and ldexpf() functions conform to C99. 2005-01-23 16:49:49 +00:00			`functions conform to`
			`.St -isoC-99 .`