man-pages/man3/scalb.3.html
2021-03-31 01:06:50 +01:00

320 lines
5.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SCALB</TITLE>
</HEAD><BODY>
<H1>SCALB</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
scalb, scalbf, scalbl - multiply floating-point number
by integral power of radix (OBSOLETE)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:///usr/include/math.h">math.h</A>&gt;</B>
<P>
<B>double scalb(double </B><I>x</I><B>, double </B><I>exp</I><B>);</B>
<BR>
<B>float scalbf(float </B><I>x</I><B>, float </B><I>exp</I><B>);</B>
<BR>
<B>long double scalbl(long double </B><I>x</I><B>, long double </B><I>exp</I><B>);</B>
<P>
Link with <I>-lm</I>.
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>scalb</B>():
<DL COMPACT><DT id="1"><DD>
_XOPEN_SOURCE&nbsp;&gt;=&nbsp;500
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;/*&nbsp;Since&nbsp;glibc&nbsp;2.19:&nbsp;*/&nbsp;_DEFAULT_SOURCE
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;/*&nbsp;Glibc&nbsp;versions&nbsp;&lt;=&nbsp;2.19:&nbsp;*/&nbsp;_BSD_SOURCE&nbsp;||&nbsp;_SVID_SOURCE
</DL>
<BR>
<B>scalbf</B>(),
<B>scalbl</B>():
<DL COMPACT><DT id="2"><DD>
_XOPEN_SOURCE&nbsp;&gt;=&nbsp;600
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;/*&nbsp;Since&nbsp;glibc&nbsp;2.19:&nbsp;*/&nbsp;_DEFAULT_SOURCE
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;/*&nbsp;Glibc&nbsp;versions&nbsp;&lt;=&nbsp;2.19:&nbsp;*/&nbsp;_BSD_SOURCE&nbsp;||&nbsp;_SVID_SOURCE
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
These functions multiply their first argument
<I>x</I>
by
<B>FLT_RADIX</B>
(probably 2)
to the power of
<I>exp</I>,
that is:
<P>
<PRE>
x * FLT_RADIX ** exp
</PRE>
<P>
The definition of
<B>FLT_RADIX</B>
can be obtained by including
<I>&lt;<A HREF="file:///usr/include/float.h">float.h</A>&gt;</I>.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these functions return
<I>x</I>
*
<B>FLT_RADIX</B>
**
<I>exp</I>.
<P>
If
<I>x</I>
or
<I>exp</I>
is a NaN, a NaN is returned.
<P>
If
<I>x</I>
is positive infinity (negative infinity),
and
<I>exp</I>
is not negative infinity,
positive infinity (negative infinity) is returned.
<P>
If
<I>x</I>
is +0 (-0), and
<I>exp</I>
is not positive infinity, +0 (-0) is returned.
<P>
If
<I>x</I>
is zero, and
<I>exp</I>
is positive infinity,
a domain error occurs, and
a NaN is returned.
<P>
If
<I>x</I>
is an infinity,
and
<I>exp</I>
is negative infinity,
a domain error occurs, and
a NaN is returned.
<P>
If the result overflows,
a range error occurs,
and the functions return
<B>HUGE_VAL</B>,
<B>HUGE_VALF</B>,
or
<B>HUGE_VALL</B>,
respectively, with a sign the same as
<I>x</I>.
<P>
If the result underflows,
a range error occurs,
and the functions return zero, with a sign the same as
<I>x</I>.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
See
<B><A HREF="/cgi-bin/man/man2html?7+math_error">math_error</A></B>(7)
for information on how to determine whether an error has occurred
when calling these functions.
<P>
The following errors can occur:
<DL COMPACT>
<DT id="3">Domain error: <I>x</I> is 0, and <I>exp</I> is positive infinity, or <I>x</I> is positive infinity and <I>exp</I> is negative infinity and the other argument is not a NaN<DD>
An invalid floating-point exception
(<B>FE_INVALID</B>)
is raised.
<DT id="4">Range error, overflow<DD>
An overflow floating-point exception
(<B>FE_OVERFLOW</B>)
is raised.
<DT id="5">Range error, underflow<DD>
An underflow floating-point exception
(<B>FE_UNDERFLOW</B>)
is raised.
</DL>
<P>
These functions do not set
<I>errno</I>.
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>scalb</B>(),
<B>scalbf</B>(),
<B>scalbl</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
<B>scalb</B>()
is specified in POSIX.1-2001, but marked obsolescent.
POSIX.1-2008 removes the specification of
<B>scalb</B>(),
recommending the use of
<B><A HREF="/cgi-bin/man/man2html?3+scalbln">scalbln</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+scalblnf">scalblnf</A></B>(3),
or
<B><A HREF="/cgi-bin/man/man2html?3+scalblnl">scalblnl</A></B>(3)
instead.
The
<B>scalb</B>()
function is from 4.3BSD.
<P>
<B>scalbf</B>()
and
<B>scalbl</B>()
are unstandardized;
<B>scalbf</B>()
is nevertheless present on several other systems
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+ldexp">ldexp</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+scalbln">scalbln</A></B>(3)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="6"><A HREF="#lbAB">NAME</A><DD>
<DT id="7"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="8"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="9"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="10"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="11"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="12"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="13"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="14"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:54 GMT, March 31, 2021
</BODY>
</HTML>