summaryrefslogtreecommitdiff
path: root/man3/fmod.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/fmod.3')
-rw-r--r--man3/fmod.361
1 files changed, 61 insertions, 0 deletions
diff --git a/man3/fmod.3 b/man3/fmod.3
new file mode 100644
index 000000000..006d8a36f
--- /dev/null
+++ b/man3/fmod.3
@@ -0,0 +1,61 @@
+.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
+.\"
+.\" Permission is granted to make and distribute verbatim copies of this
+.\" manual provided the copyright notice and this permission notice are
+.\" preserved on all copies.
+.\"
+.\" Permission is granted to copy and distribute modified versions of this
+.\" manual under the conditions for verbatim copying, provided that the
+.\" entire resulting derived work is distributed under the terms of a
+.\" permission notice identical to this one.
+.\"
+.\" Since the Linux kernel and libraries are constantly changing, this
+.\" manual page may be incorrect or out-of-date. The author(s) assume no
+.\" responsibility for errors or omissions, or for damages resulting from
+.\" the use of the information contained herein. The author(s) may not
+.\" have taken the same level of care in the production of this manual,
+.\" which is licensed free of charge, as they might when working
+.\" professionally.
+.\"
+.\" Formatted or processed versions of this manual, if unaccompanied by
+.\" the source, must acknowledge the copyright and authors of this work.
+.\"
+.\" References consulted:
+.\" Linux libc source code
+.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
+.\" 386BSD man pages
+.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
+.\" Modified 2002-07-27 by Walter Harms
+.\" (walter.harms@informatik.uni-oldenburg.de)
+.\"
+.TH FMOD 3 2002-07-27 "" "Linux Programmer's Manual"
+.SH NAME
+fmod, fmodf, fmodl \- floating-point remainder function
+.SH SYNOPSIS
+.nf
+.B #include <math.h>
+.sp
+.BI "double fmod(double " x ", double " y );
+.sp
+.BI "float fmodf(float " x ", float " y );
+.sp
+.BI "long double fmodl(long double " x ", long double " y );
+.fi
+.sp
+Link with \-lm.
+.SH DESCRIPTION
+The \fBfmod()\fP function computes the remainder of dividing \fIx\fP by
+\fIy\fP. The return value is \fIx\fP - \fIn\fP * \fIy\fP, where \fIn\fP
+is the quotient of \fIx\fP / \fIy\fP, rounded towards zero to an integer.
+.SH "RETURN VALUE"
+The \fBfmod()\fP function returns the remainder, unless \fIy\fP is zero,
+when the function fails and \fIerrno\fP is set.
+.SH ERRORS
+.TP
+.B EDOM
+The denominator \fIy\fP is zero.
+.SH "CONFORMING TO"
+SVID 3, POSIX, BSD 4.3, ISO 9899.
+The float and the long double variants are C99 requirements.
+.SH "SEE ALSO"
+.BR remainder (3)