aboutsummaryrefslogtreecommitdiff
path: root/lib/libc/gen/ldexp.3
diff options
context:
space:
mode:
authorDavid Schultz <das@FreeBSD.org>2005-01-23 16:49:49 +0000
committerDavid Schultz <das@FreeBSD.org>2005-01-23 16:49:49 +0000
commite33621db7f3334428569cfe19da1f48dc6eb1605 (patch)
tree3766e49a88d10316f5a0050214e1b96e9c65a82f /lib/libc/gen/ldexp.3
parent6f1dd8edc029eead6eef0c38773fb940de48155c (diff)
downloadsrc-e33621db7f3334428569cfe19da1f48dc6eb1605.tar.gz
src-e33621db7f3334428569cfe19da1f48dc6eb1605.zip
- 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.
Notes
Notes: svn path=/head/; revision=140673
Diffstat (limited to 'lib/libc/gen/ldexp.3')
-rw-r--r--lib/libc/gen/ldexp.329
1 files changed, 12 insertions, 17 deletions
diff --git a/lib/libc/gen/ldexp.3 b/lib/libc/gen/ldexp.3
index 6ebe68d6de9c..58ada2f6f4c4 100644
--- a/lib/libc/gen/ldexp.3
+++ b/lib/libc/gen/ldexp.3
@@ -36,39 +36,32 @@
.\" @(#)ldexp.3 8.2 (Berkeley) 4/19/94
.\" $FreeBSD$
.\"
-.Dd April 19, 1994
+.Dd January 23, 2005
.Dt LDEXP 3
.Os
.Sh NAME
.Nm ldexp
.Nd multiply floating-point number by integral power of 2
.Sh LIBRARY
-.Lb libc
+.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
+and
+.Fn ldexpf
+functions multiply a floating-point number by an integral
power of 2.
.Sh RETURN VALUES
-The
-.Fn ldexp
-function returns the value of
+These functions return the value of
.Fa x
times 2 raised to the power
.Fa exp .
-.Pp
-If the resultant value would cause an overflow,
-the global variable
-.Va errno
-is set to
-.Er ERANGE
-and the value
-.Dv HUGE
-is returned.
.Sh SEE ALSO
.Xr frexp 3 ,
.Xr math 3 ,
@@ -76,5 +69,7 @@ is returned.
.Sh STANDARDS
The
.Fn ldexp
-function conforms to
-.St -isoC .
+and
+.Fn ldexpf
+functions conform to
+.St -isoC-99 .