90 lines
2.7 KiB
Groff
90 lines
2.7 KiB
Groff
|
.\" $NetBSD: ldexp.3,v 1.1 2006/07/03 16:03:56 drochner Exp $
|
||
|
|
.\"
|
||
|
|
.\" 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
|
||
|
|
.\"
|
||
|
|
.Dd March 21, 2006
|
||
|
|
.Dt LDEXP 3
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm ldexp
|
||
|
|
.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"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn ldexp
|
||
|
|
function multiplies a floating-point number by an integral
|
||
|
|
power of 2.
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
The
|
||
|
|
.Fn ldexp
|
||
|
|
function returns the value of
|
||
|
|
.Fa x
|
||
|
|
times 2 raised to the power
|
||
|
|
.Fa exp .
|
||
|
|
.Pp
|
||
|
|
If the input
|
||
|
|
.Va x
|
||
|
|
is a NaN, infinity, or 0.0, it is returned unchanged.
|
||
|
|
.Pp
|
||
|
|
If the result would cause an overflow,
|
||
|
|
the global variable
|
||
|
|
.Va errno
|
||
|
|
is set to
|
||
|
|
.Er ERANGE
|
||
|
|
and infinity is returned, with the same sign as
|
||
|
|
.Fa x .
|
||
|
|
.Pp
|
||
|
|
If the result would cause underflow to 0.0,
|
||
|
|
the global variable
|
||
|
|
.Va errno
|
||
|
|
is set to
|
||
|
|
.Er ERANGE
|
||
|
|
and the value 0.0 is returned.
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr frexp 3 ,
|
||
|
|
.Xr math 3 ,
|
||
|
|
.Xr modf 3
|
||
|
|
.Sh STANDARDS
|
||
|
|
The
|
||
|
|
.Fn ldexp
|
||
|
|
function conforms to
|
||
|
|
.St -ansiC .
|