xref: /freebsd/lib/libc/gen/ldexp.3 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd March 4, 2005
33.Dt LDEXP 3
34.Os
35.Sh NAME
36.Nm ldexp ,
37.Nm ldexpf ,
38.Nm ldexpl
39.Nd multiply floating-point number by integral power of 2
40.Sh LIBRARY
41.Lb libm
42.Sh SYNOPSIS
43.In math.h
44.Ft double
45.Fn ldexp "double x" "int exp"
46.Ft float
47.Fn ldexpf "float x" "int exp"
48.Ft long double
49.Fn ldexpl "long double x" "int exp"
50.Sh DESCRIPTION
51The
52.Fn ldexp ,
53.Fn ldexpf ,
54and
55.Fn ldexpl
56functions multiply a floating-point number by an integral
57power of 2.
58.Sh RETURN VALUES
59These functions return the value of
60.Fa x
61times 2 raised to the power
62.Fa exp .
63.Sh SEE ALSO
64.Xr frexp 3 ,
65.Xr math 3 ,
66.Xr modf 3
67.Sh STANDARDS
68The
69.Fn ldexp ,
70.Fn ldexpf ,
71and
72.Fn ldexpl
73functions conform to
74.St -isoC-99 .
75