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

244 lines
5.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of RINT</TITLE>
</HEAD><BODY>
<H1>RINT</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>
nearbyint, nearbyintf, nearbyintl, rint, rintf, rintl - round
to nearest integer
<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 nearbyint(double </B><I>x</I><B>);</B>
<B>float nearbyintf(float </B><I>x</I><B>);</B>
<B>long double nearbyintl(long double </B><I>x</I><B>);</B>
<B>double rint(double </B><I>x</I><B>);</B>
<B>float rintf(float </B><I>x</I><B>);</B>
<B>long double rintl(long double </B><I>x</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>nearbyint</B>(),
<B>nearbyintf</B>(),
<B>nearbyintl</B>():
<DL COMPACT><DT id="1"><DD>
_POSIX_C_SOURCE&nbsp;&gt;=&nbsp;200112L || _ISOC99_SOURCE
</DL>
<BR>
<B>rint</B>():
<DL COMPACT><DT id="2"><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>rintf</B>(),
<B>rintl</B>():
<DL COMPACT><DT id="3"><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>
The
<B>nearbyint</B>(),
<B>nearbyintf</B>(),
and
<B>nearbyintl</B>()
functions round their argument to an integer value in floating-point
format, using the current rounding direction (see
<B><A HREF="/cgi-bin/man/man2html?3+fesetround">fesetround</A></B>(3))
and without raising the
<I>inexact</I>
exception.
When the current rounding direction is to nearest, these
functions round halfway cases to the even integer in accordance with
IEEE-754.
<P>
The
<B>rint</B>(),
<B>rintf</B>(),
and
<B>rintl</B>()
functions do the same, but will raise the
<I>inexact</I>
exception
(<B>FE_INEXACT</B>,
checkable via
<B><A HREF="/cgi-bin/man/man2html?3+fetestexcept">fetestexcept</A></B>(3))
when the result differs in value from the argument.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
These functions return the rounded integer value.
<P>
If
<I>x</I>
is integral, +0, -0, NaN, or infinite,
<I>x</I>
itself is returned.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
No errors occur.
POSIX.1-2001 documents a range error for overflows, but see NOTES.
<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>nearbyint</B>(),
<B>nearbyintf</B>(),
<BR>
<B>nearbyintl</B>(),
<B>rint</B>(),
<BR>
<B>rintf</B>(),
<B>rintl</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>NOTES</H2>
SUSv2 and POSIX.1-2001 contain text about overflow (which might set
<I>errno</I>
to
<B>ERANGE</B>,
or raise an
<B>FE_OVERFLOW</B>
exception).
In practice, the result cannot overflow on any current machine,
so this error-handling stuff is just nonsense.
(More precisely, overflow can happen only when the maximum value
of the exponent is smaller than the number of mantissa bits.
For the IEEE-754 standard 32-bit and 64-bit floating-point numbers
the maximum value of the exponent is 128 (respectively, 1024),
and the number of mantissa bits is 24 (respectively, 53).)
<P>
If you want to store the rounded value in an integer type,
you probably want to use one of the functions described in
<B><A HREF="/cgi-bin/man/man2html?3+lrint">lrint</A></B>(3)
instead.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+ceil">ceil</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+floor">floor</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+lrint">lrint</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+round">round</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+trunc">trunc</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="4"><A HREF="#lbAB">NAME</A><DD>
<DT id="5"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="6"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="7"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="8"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="9"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="10"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="11"><A HREF="#lbAI">NOTES</A><DD>
<DT id="12"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="13"><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:54 GMT, March 31, 2021
</BODY>
</HTML>