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

243 lines
4.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of LOG1P</TITLE>
</HEAD><BODY>
<H1>LOG1P</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>
log1p, log1pf, log1pl - logarithm of 1 plus argument
<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 log1p(double </B><I>x</I><B>);</B>
<B>float log1pf(float </B><I>x</I><B>);</B>
<B>long double log1pl(long double </B><I>x</I><B>);</B>
</PRE>
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>log1p</B>():
<DL COMPACT><DT id="1"><DD>
_ISOC99_SOURCE || _POSIX_C_SOURCE&nbsp;&gt;=&nbsp;200112L
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;_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>log1pf</B>(),
<B>log1pl</B>():
<DL COMPACT><DT id="2"><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 a value equivalent to
<P>
<PRE>
log (1 + <I>x</I>)
</PRE>
<P>
The result is computed in a way
that is accurate even if the value of
<I>x</I>
is near zero.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these functions return the natural logarithm of
<I>(1&nbsp;+&nbsp;x)</I>.
<P>
If
<I>x</I>
is a NaN,
a NaN is returned.
<P>
If
<I>x</I>
is positive infinity, positive infinity is returned.
<P>
If
<I>x</I>
is -1, a pole error occurs,
and the functions return
-<B>HUGE_VAL</B>,
-<B>HUGE_VALF</B>,
or
-<B>HUGE_VALL</B>,
respectively.
<P>
If
<I>x</I>
is less than -1 (including negative infinity),
a domain error occurs,
and a NaN (not a number) 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="3">Domain error: <I>x</I> is less than -1<DD>
<I>errno</I>
is set to
<B>EDOM</B>
(but see BUGS).
An invalid floating-point exception
(<B>FE_INVALID</B>)
is raised.
<DT id="4">Pole error: <I>x</I> is -1<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.
</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>log1p</B>(),
<B>log1pf</B>(),
<B>log1pl</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.
<A NAME="lbAI">&nbsp;</A>
<H2>BUGS</H2>
Before version 2.22, the glibc implementation did not set
<I>errno</I>
to
<B>EDOM</B>
when a domain error occurred.
<P>
Before version 2.22, the glibc implementation did not set
<I>errno</I>
to
<B>ERANGE</B>
when a range error occurred.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+exp">exp</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+expm1">expm1</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+log">log</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="5"><A HREF="#lbAB">NAME</A><DD>
<DT id="6"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="7"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="8"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="9"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="10"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="11"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="12"><A HREF="#lbAI">BUGS</A><DD>
<DT id="13"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="14"><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:47 GMT, March 31, 2021
</BODY>
</HTML>