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