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

242 lines
4.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of FMOD</TITLE>
</HEAD><BODY>
<H1>FMOD</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>
fmod, fmodf, fmodl - floating-point remainder function
<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 fmod(double </B><I>x</I><B>, double </B><I>y</I><B>);</B>
<B>float fmodf(float </B><I>x</I><B>, float </B><I>y</I><B>);</B>
<B>long double fmodl(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>fmodf</B>(),
<B>fmodl</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 compute the floating-point remainder of dividing
<I>x</I>
by
<I>y</I>.
The return value is
<I>x</I>
-
<I>n</I>
*
<I>y</I>,
where
<I>n</I>
is the quotient of
<I>x</I>
/
<I>y</I>,
rounded toward zero to an integer.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these
functions return the value <I>x</I>&nbsp;-&nbsp;<I>n</I>*<I>y</I>,
for some integer
<I>n</I>,
such that the returned value has the same sign as
<I>x</I>
and a magnitude less than the magnitude of
<I>y</I>.
<P>
If
<I>x</I>
or
<I>y</I>
is a NaN, a NaN is returned.
<P>
If
<I>x</I>
is an infinity,
a domain error occurs, and
a NaN is returned.
<P>
If
<I>y</I>
is zero,
a domain error occurs, and
a NaN is returned.
<P>
If
<I>x</I>
is +0 (-0), and
<I>y</I>
is not zero, +0 (-0) 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 an infinity<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="3">Domain error: <I>y</I> is zero<DD>
<I>errno</I>
is set to
<B>EDOM</B>.
An invalid floating-point exception
(<B>FE_INVALID</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>fmod</B>(),
<B>fmodf</B>(),
<B>fmodl</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>
Before version 2.10, the glibc implementation did not set
<I>errno</I>
to
<B>EDOM</B>
when a domain error occurred for an infinite
<I>x</I>.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+remainder">remainder</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">BUGS</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:43 GMT, March 31, 2021
</BODY>
</HTML>