xref: /freebsd/lib/msun/man/scalbn.3 (revision 61e21613)
1.\" Copyright (c) 1985, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd March 4, 2005
29.Dt SCALBN 3
30.Os
31.Sh NAME
32.Nm scalbln ,
33.Nm scalblnf ,
34.Nm scalblnl ,
35.Nm scalbn ,
36.Nm scalbnf ,
37.Nm scalbnl
38.Nd adjust exponent
39.Sh LIBRARY
40.Lb libm
41.Sh SYNOPSIS
42.In math.h
43.Ft double
44.Fn scalbln "double x" "long n"
45.Ft float
46.Fn scalblnf "float x" "long n"
47.Ft long double
48.Fn scalblnl "long double x" "long n"
49.Ft double
50.Fn scalbn "double x" "int n"
51.Ft float
52.Fn scalbnf "float x" "int n"
53.Ft long double
54.Fn scalbnl "long double x" "int n"
55.Sh DESCRIPTION
56These routines return
57.Fa x Ns \(**(2** Ns Fa n )
58computed by exponent manipulation.
59.Sh SEE ALSO
60.Xr ieee 3 ,
61.Xr math 3
62.Sh STANDARDS
63These routines conform to
64.St -isoC-99 ,
65and they implement the Scalb function recommended by
66.St -ieee754 .
67.Sh HISTORY
68The
69.Fn scalbn
70and
71.Fn scalbnf
72functions appeared in
73.Bx 4.3
74and
75.Fx 2.0 ,
76respectively.
77The
78.Fn scalbln
79and
80.Fn scalblnf
81functions first appeared in
82.Fx 5.3 ,
83and
84.Fn scalblnl
85and
86.Fn scalbln
87in
88.Fx 6.0 .
89