man3/fmod.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  28 .\" Modified 2002-07-27 by Walter Harms
  29 .\"     (walter.harms@informatik.uni-oldenburg.de)
  30 .\"
  31 .TH FMOD 3  2002-07-27 "" "Linux Programmer's Manual"
  32 .SH NAME
  33 fmod, fmodf, fmodl \- floating-point remainder function
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <math.h>
  37 .sp
  38 .BI "double fmod(double " x ", double " y );
  39 .br
  40 .BI "float fmodf(float " x ", float " y );
  41 .br
  42 .BI "long double fmodl(long double " x ", long double " y );
  43 .fi
  44 .sp
  45 Link with \-lm.
  46 .SH DESCRIPTION
  47 The \fBfmod\fP() function computes the remainder of dividing \fIx\fP by
  48 \fIy\fP.  The return value is \fIx\fP \- \fIn\fP * \fIy\fP, where \fIn\fP
  49 is the quotient of \fIx\fP / \fIy\fP, rounded towards zero to an integer.
  50 .SH "RETURN VALUE"
  51 The \fBfmod\fP() function returns the remainder, unless \fIy\fP is zero,
  52 when the function fails and \fIerrno\fP is set.
  53 .SH ERRORS
  54 .TP
  55 .B EDOM
  56 The denominator \fIy\fP is zero.
  57 .SH "CONFORMING TO"
  58 SVr4, 4.3BSD, C89.
  59 The
  60 .I float
  61 and
  62 .I "long double"
  63 variants are C99 requirements.
  64 .SH "SEE ALSO"
  65 .BR remainder (3)