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

536 lines
7.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of POW</TITLE>
</HEAD><BODY>
<H1>POW</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>
pow, powf, powl - power functions
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/math.h">math.h</A>&gt;</B>
<B>double pow(double </B><I>x</I><B>, double </B><I>y</I><B>);</B>
<B>float powf(float </B><I>x</I><B>, float </B><I>y</I><B>);</B>
<B>long double powl(long double </B><I>x</I><B>, long double </B><I>y</I><B>);</B>
</PRE>
<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>powf</B>(),
<B>powl</B>():
<DL COMPACT><DT id="1"><DD>
_ISOC99_SOURCE || _POSIX_C_SOURCE&nbsp;&gt;=&nbsp;200112L
<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 return the value of
<I>x</I>
raised to the
power of
<I>y</I>.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these functions return the value of
<I>x</I>
to the power of
<I>y</I>.
<P>
If
<I>x</I>
is a finite value less than 0, and
<I>y</I>
is a finite noninteger, 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 the mathematically correct sign.
<P>
If result underflows, and is not representable,
a range error occurs,
and 0.0 is returned.
<P>
Except as specified below, if
<I>x</I>
or
<I>y</I>
is a NaN, the result is a NaN.
<P>
If
<I>x</I>
is +1, the result is 1.0 (even if
<I>y</I>
is a NaN).
<P>
If
<I>y</I>
is 0, the result is 1.0 (even if
<I>x</I>
is a NaN).
<P>
If
<I>x</I>
is +0 (-0),
and
<I>y</I>
is an odd integer greater than 0,
the result is +0 (-0).
<P>
If
<I>x</I>
is 0,
and
<I>y</I>
greater than 0 and not an odd integer,
the result is +0.
<P>
If
<I>x</I>
is -1,
and
<I>y</I>
is positive infinity or negative infinity,
the result is 1.0.
<P>
If the absolute value of
<I>x</I>
is less than 1,
and
<I>y</I>
is negative infinity,
the result is positive infinity.
<P>
If the absolute value of
<I>x</I>
is greater than 1,
and
<I>y</I>
is negative infinity,
the result is +0.
<P>
If the absolute value of
<I>x</I>
is less than 1,
and
<I>y</I>
is positive infinity,
the result is +0.
<P>
If the absolute value of
<I>x</I>
is greater than 1,
and
<I>y</I>
is positive infinity,
the result is positive infinity.
<P>
If
<I>x</I>
is negative infinity,
and
<I>y</I>
is an odd integer less than 0,
the result is -0.
<P>
If
<I>x</I>
is negative infinity,
and
<I>y</I>
less than 0 and not an odd integer,
the result is +0.
<P>
If
<I>x</I>
is negative infinity,
and
<I>y</I>
is an odd integer greater than 0,
the result is negative infinity.
<P>
If
<I>x</I>
is negative infinity,
and
<I>y</I>
greater than 0 and not an odd integer,
the result is positive infinity.
<P>
If
<I>x</I>
is positive infinity,
and
<I>y</I>
less than 0,
the result is +0.
<P>
If
<I>x</I>
is positive infinity,
and
<I>y</I>
greater than 0,
the result is positive infinity.
<P>
If
<I>x</I>
is +0 or -0,
and
<I>y</I>
is an odd integer less than 0,
a pole error occurs and
<B>HUGE_VAL</B>,
<B>HUGE_VALF</B>,
or
<B>HUGE_VALL</B>,
is returned,
with the same sign as
<I>x</I>.
<P>
If
<I>x</I>
is +0 or -0,
and
<I>y</I>
is less than 0 and not an odd integer,
a pole error occurs and
+<B>HUGE_VAL</B>,
+<B>HUGE_VALF</B>,
or
+<B>HUGE_VALL</B>,
is returned.
<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="2">Domain error: <I>x</I> is negative, and <I>y</I> is a finite noninteger<DD>
<I>errno</I>
is set to
<B>EDOM</B>.
An invalid floating-point exception
(<B>FE_INVALID</B>)
is raised.
<DT id="3">Pole error: <I>x</I> is zero, and <I>y</I> is negative<DD>
<I>errno</I>
is set to
<B>ERANGE</B>
(but see BUGS).
A divide-by-zero floating-point exception
(<B>FE_DIVBYZERO</B>)
is raised.
<DT id="4">Range error: the result overflows<DD>
<I>errno</I>
is set to
<B>ERANGE</B>.
An overflow floating-point exception
(<B>FE_OVERFLOW</B>)
is raised.
<DT id="5">Range error: the result underflows<DD>
<I>errno</I>
is set to
<B>ERANGE</B>.
An underflow floating-point exception
(<B>FE_UNDERFLOW</B>)
is raised.
</DL>
<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>pow</B>(),
<B>powf</B>(),
<B>powl</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
C99, POSIX.1-2001, POSIX.1-2008.
<P>
The variant returning
<I>double</I>
also conforms to
SVr4, 4.3BSD, C89.
<A NAME="lbAI">&nbsp;</A>
<H2>BUGS</H2>
On 64-bits,
<B>pow</B>()
may be more than 10,000 times slower for some (rare) inputs
than for other nearby inputs.
This affects only
<B>pow</B>(),
and not
<B>powf</B>()
nor
<B>powl</B>().
<P>
In glibc 2.9 and earlier,
when a pole error occurs,
<I>errno</I>
is set to
<B>EDOM</B>
instead of the POSIX-mandated
<B>ERANGE</B>.
Since version 2.10,
glibc does the right thing.
<P>
If
<I>x</I>
is negative,
then large negative or positive
<I>y</I>
values yield a NaN as the function result, with
<I>errno</I>
set to
<B>EDOM</B>,
and an invalid
(<B>FE_INVALID</B>)
floating-point exception.
For example, with
<B>pow</B>(),
one sees this behavior when the absolute value of
<I>y</I>
is greater than about 9.223373e18.
<P>
In version 2.3.2 and earlier,
when an overflow or underflow error occurs, glibc's
<B>pow</B>()
generates a bogus invalid floating-point exception
(<B>FE_INVALID</B>)
in addition to the overflow or underflow exception.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+cbrt">cbrt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+cpow">cpow</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sqrt">sqrt</A></B>(3)
<A NAME="lbAK">&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">BUGS</A><DD>
<DT id="14"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="15"><A HREF="#lbAK">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:52 GMT, March 31, 2021
</BODY>
</HTML>