xref: /freebsd/lib/libc/gen/ldexp.3 (revision 3e0f6b97b257a96f7275e4442204263e44b16686)
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. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)ldexp.3	8.2 (Berkeley) 4/19/94
37.\"
38.Dd April 19, 1994
39.Dt LDEXP 3
40.Os
41.Sh NAME
42.Nm ldexp
43.Nd multiply floating-point number by integral power of 2
44.Sh SYNOPSIS
45.Fd #include <math.h>
46.Ft double
47.Fn ldexp "double x" "int exp"
48.Sh DESCRIPTION
49The
50.Fn ldexp
51function multiplies a floating-point number by an integral
52power of 2.
53.Sh RETURN VALUES
54The
55.Fn ldexp
56function returns the value of
57.Fa x
58times 2 raised to the power
59.Fa exp .
60.Pp
61If the resultant value would cause an overflow,
62the global variable
63.Va errno
64is set to
65.Er ERANGE
66and the value
67.Dv HUGE
68is returned.
69.Sh SEE ALSO
70.Xr frexp 3 ,
71.Xr math 3 ,
72.Xr modf 3
73.Sh STANDARDS
74The
75.Fn ldexp
76function conforms to
77.St -ansiC .
78