2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 2004 Andries Brouwer <aeb@cwi.nl>.
|
2008-08-01 05:26:41 +00:00
|
|
|
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2008-08-01 05:54:27 +00:00
|
|
|
.TH SCALB 3 2008-08-05 "" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2008-08-01 05:26:41 +00:00
|
|
|
scalb, scalbf, scalbl \- multiply floating-point number
|
|
|
|
by integral power of radix (OBSOLETE)
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <math.h>
|
|
|
|
.sp
|
|
|
|
.BI "double scalb(double " x ", double " exp );
|
|
|
|
.br
|
|
|
|
.BI "float scalbf(float " x ", double " exp );
|
|
|
|
.br
|
|
|
|
.BI "long double scalbl(long double " x ", double " exp );
|
|
|
|
.sp
|
2007-07-21 05:25:03 +00:00
|
|
|
Link with \fI\-lm\fP.
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.ad l
|
2008-08-01 05:26:41 +00:00
|
|
|
.BR scalb ():
|
2007-07-08 12:11:40 +00:00
|
|
|
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500
|
|
|
|
.br
|
2008-08-01 05:26:41 +00:00
|
|
|
.BR scalbf (),
|
|
|
|
.BR scalbl ():
|
|
|
|
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600
|
2007-07-08 12:11:40 +00:00
|
|
|
.ad b
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
These functions multiply their first argument
|
|
|
|
.I x
|
2007-06-22 19:42:52 +00:00
|
|
|
by
|
|
|
|
.B FLT_RADIX
|
2008-08-01 05:26:41 +00:00
|
|
|
(probably 2)
|
|
|
|
to the power of
|
|
|
|
.IR exp ,
|
|
|
|
that is:
|
|
|
|
.nf
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2008-08-01 05:26:41 +00:00
|
|
|
x * FLT_RADIX ** exp
|
|
|
|
.fi
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2008-08-01 05:26:41 +00:00
|
|
|
The definition of
|
2007-06-22 19:42:52 +00:00
|
|
|
.B FLT_RADIX
|
2008-08-01 05:26:41 +00:00
|
|
|
can be obtained by including
|
2005-07-19 15:36:19 +00:00
|
|
|
.IR <float.h> .
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" not in /usr/include but in a gcc lib
|
2008-08-01 05:26:41 +00:00
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, these functions return \fIx\fP * \fBFLT_RADIX\fP ** \fIexp\fP.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
or
|
|
|
|
.I exp
|
|
|
|
is a NaN, a NaN is returned.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is positive infinity (negative infinity),
|
|
|
|
and
|
|
|
|
.I exp
|
|
|
|
is not negative infinity,
|
|
|
|
positive infinity (negative infinity) is returned.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is +0 (\-0), and
|
|
|
|
.I exp
|
|
|
|
is not positive infinity, +0 (\-0) is returned.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is zero, and
|
|
|
|
.I exp
|
|
|
|
is positive infinity,
|
2008-08-04 16:00:58 +00:00
|
|
|
a domain error occurs, and
|
2008-08-01 05:26:41 +00:00
|
|
|
a NaN is returned.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is an infinity,
|
|
|
|
and
|
|
|
|
.I exp
|
2008-08-05 10:33:06 +00:00
|
|
|
is negative infinity,
|
2008-08-04 16:00:58 +00:00
|
|
|
a domain error occurs, and
|
2008-08-01 05:26:41 +00:00
|
|
|
a NaN is returned.
|
|
|
|
|
|
|
|
If the result overflows,
|
2008-08-04 16:00:58 +00:00
|
|
|
a range error occurs,
|
2008-08-01 05:26:41 +00:00
|
|
|
and the functions return
|
|
|
|
.BR HUGE_VAL ,
|
|
|
|
.BR HUGE_VALF ,
|
|
|
|
or
|
|
|
|
.BR HUGE_VALL ,
|
|
|
|
respectively, with a sign the same as
|
|
|
|
.IR x .
|
|
|
|
|
|
|
|
If the result underflows,
|
2008-08-04 16:00:58 +00:00
|
|
|
a range error occurs,
|
2008-08-01 05:26:41 +00:00
|
|
|
and the functions return zero, with a sign the same as
|
|
|
|
.IR x .
|
|
|
|
.SH ERRORS
|
|
|
|
See
|
|
|
|
.BR math_error (7)
|
|
|
|
for information on how to determine whether an error has occurred
|
|
|
|
when calling these functions.
|
|
|
|
.PP
|
|
|
|
The following errors can occur:
|
|
|
|
.TP
|
|
|
|
Domain error: \fIx\fP is 0, and \fIexp\fP is positive infinity, \
|
|
|
|
or \fIx\fP is positive infinity and \fIexp\fP is negative infinity
|
|
|
|
and the other argument is not a NaN
|
|
|
|
.\" .I errno
|
|
|
|
.\" is set to
|
|
|
|
.\" .BR EDOM .
|
|
|
|
An invalid floating-point exception
|
|
|
|
.RB ( FE_INVALID )
|
|
|
|
is raised.
|
|
|
|
.TP
|
|
|
|
Range error, overflow
|
|
|
|
.\" .I errno
|
|
|
|
.\" is set to
|
|
|
|
.\" .BR ERANGE .
|
|
|
|
An overflow floating-point exception
|
|
|
|
.RB ( FE_OVERFLOW )
|
|
|
|
is raised.
|
|
|
|
.TP
|
|
|
|
Range error, underflow
|
|
|
|
.\" .I errno
|
|
|
|
.\" is set to
|
|
|
|
.\" .BR ERANGE .
|
|
|
|
An underflow floating-point exception
|
|
|
|
.RB ( FE_UNDERFLOW )
|
|
|
|
is raised.
|
|
|
|
.PP
|
|
|
|
These functions do not set
|
|
|
|
.IR errno .
|
|
|
|
.\" FIXME . Is it intentional that these functions do not set errno?
|
|
|
|
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6803
|
|
|
|
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6804
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2008-08-01 05:26:41 +00:00
|
|
|
.BR scalb ()
|
|
|
|
is specified in POSIX.1-2001, but marked obsolescent.
|
|
|
|
.\" FIXME . Mar 08: The next POSIX.1 revision removes scalb().
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR scalb ()
|
2005-07-18 15:05:56 +00:00
|
|
|
function is from 4.3BSD.
|
2008-08-01 05:26:41 +00:00
|
|
|
|
|
|
|
.BR scalbf ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2008-08-01 05:26:41 +00:00
|
|
|
.BR scalbl ()
|
|
|
|
are unstandardized;
|
|
|
|
.BR scalbf ()
|
|
|
|
is nevertheless present on several other systems
|
|
|
|
.\" Looking at header files: scalbf() is present on the
|
|
|
|
.\" BSDs, Tru64, HP-UX 11, Irix 6.5; scalbl() is on HP-UX 11 and Tru64.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
2008-08-01 05:26:41 +00:00
|
|
|
.BR ldexp (3),
|
|
|
|
.BR scalbln (3)
|