original/man3/fmod.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 2002-07-27 by Walter Harms
  31 .\"     (walter.harms@informatik.uni-oldenburg.de)
  32 .\"
  33 .TH FMOD 3  2010-09-20 "" "Linux Programmer's Manual"
  34 .SH NAME
  35 fmod, fmodf, fmodl \- floating-point remainder function
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <math.h>
  39 .sp
  40 .BI "double fmod(double " x ", double " y );
  41 .br
  42 .BI "float fmodf(float " x ", float " y );
  43 .br
  44 .BI "long double fmodl(long double " x ", long double " y );
  45 .fi
  46 .sp
  47 Link with \fI\-lm\fP.
  48 .sp
  49 .in -4n
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .in
  53 .sp
  54 .ad l
  55 .BR fmodf (),
  56 .BR fmodl ():
  57 .RS 4
  58 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  59 _POSIX_C_SOURCE\ >=\ 200112L;
  60 .br
  61 or
  62 .I cc\ -std=c99
  63 .RE
  64 .ad
  65 .SH DESCRIPTION
  66 The
  67 .BR fmod ()
  68 function computes the floating-point remainder of dividing \fIx\fP by
  69 \fIy\fP.
  70 The return value is \fIx\fP \- \fIn\fP * \fIy\fP, where \fIn\fP
  71 is the quotient of \fIx\fP / \fIy\fP, rounded toward zero to an integer.
  72 .SH "RETURN VALUE"
  73 On success, these
  74 functions return the value \fIx\fP\ \-\ \fIn\fP*\fIy\fP,
  75 for some integer \fIn\fP,
  76 such that the returned value has the same sign as
  77 .I x
  78 and a magnitude less than the magnitude of
  79 .IR y .
  80
  81 If
  82 .I x
  83 or
  84 .I y
  85 is a NaN, a NaN is returned.
  86
  87 If
  88 .I x
  89 is an infinity,
  90 a domain error occurs, and
  91 a NaN is returned.
  92
  93 If
  94 .I y
  95 is zero,
  96 a domain error occurs, and
  97 a NaN is returned.
  98
  99 If
 100 .I x
 101 is +0 (\-0), and
 102 .I y
 103 is not zero, +0 (\-0) is returned.
 104 .SH ERRORS
 105 See
 106 .BR math_error (7)
 107 for information on how to determine whether an error has occurred
 108 when calling these functions.
 109 .PP
 110 The following errors can occur:
 111 .TP
 112 Domain error: \fIx\fP is an infinity
 113 .I errno
 114 is set to
 115 .BR EDOM
 116 (but see BUGS).
 117 An invalid floating-point exception
 118 .RB ( FE_INVALID )
 119 is raised.
 120 .TP
 121 Domain error: \fIy\fP is zero
 122 .I errno
 123 is set to
 124 .BR EDOM .
 125 An invalid floating-point exception
 126 .RB ( FE_INVALID )
 127 is raised.
 128 .\" POSIX.1 documents an optional underflow error, but AFAICT it doesn't
 129 .\" (can't?) occur -- mtk, Jul 2008
 130 .SH BUGS
 131 Before version 2.10, the glibc implementation did not set
 132 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6784
 133 .I errno
 134 to
 135 .B EDOM
 136 when a domain error occurred for an infinite
 137 .IR x .
 138 .SH "CONFORMING TO"
 139 C99, POSIX.1-2001.
 140 The variant returning
 141 .I double
 142 also conforms to
 143 SVr4, 4.3BSD, C89.
 144 .SH "SEE ALSO"
 145 .BR remainder (3)