]>
Commit | Line | Data |
---|---|---|
fea681da | 1 | .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) |
1cc72c09 MK |
2 | .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk |
3 | .\" <mtk.manpages@gmail.com> | |
fea681da | 4 | .\" |
93015253 | 5 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
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. | |
c13182ef | 14 | .\" |
fea681da MK |
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. | |
c13182ef | 22 | .\" |
fea681da MK |
23 | .\" Formatted or processed versions of this manual, if unaccompanied by |
24 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 25 | .\" %%%LICENSE_END |
fea681da MK |
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 | .\" | |
4b8c67d9 | 35 | .TH FMOD 3 2017-09-15 "" "Linux Programmer's Manual" |
fea681da MK |
36 | .SH NAME |
37 | fmod, fmodf, fmodl \- floating-point remainder function | |
38 | .SH SYNOPSIS | |
39 | .nf | |
40 | .B #include <math.h> | |
68e4db0a | 41 | .PP |
fea681da | 42 | .BI "double fmod(double " x ", double " y ); |
fea681da | 43 | .BI "float fmodf(float " x ", float " y ); |
fea681da MK |
44 | .BI "long double fmodl(long double " x ", long double " y ); |
45 | .fi | |
68e4db0a | 46 | .PP |
20c58d70 | 47 | Link with \fI\-lm\fP. |
68e4db0a | 48 | .PP |
1cc72c09 MK |
49 | .in -4n |
50 | Feature Test Macro Requirements for glibc (see | |
51 | .BR feature_test_macros (7)): | |
52 | .in | |
68e4db0a | 53 | .PP |
1cc72c09 MK |
54 | .ad l |
55 | .BR fmodf (), | |
56 | .BR fmodl (): | |
b90c43a8 | 57 | .RS 4 |
e9d91bcf MK |
58 | _ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L |
59 | || /* Since glibc 2.19: */ _DEFAULT_SOURCE | |
60 | || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE | |
b90c43a8 MK |
61 | .RE |
62 | .ad | |
fea681da | 63 | .SH DESCRIPTION |
5600f73a | 64 | These functions compute the floating-point remainder of dividing |
022671eb MK |
65 | .I x |
66 | by | |
67 | .IR y . | |
68 | The return value is | |
51700fd7 | 69 | .IR x |
022671eb MK |
70 | \- |
71 | .I n | |
72 | * | |
73 | .IR y , | |
74 | where | |
75 | .I n | |
76 | is the quotient of | |
77 | .I x | |
78 | / | |
79 | .IR y , | |
80 | rounded toward zero to an integer. | |
47297adb | 81 | .SH RETURN VALUE |
1cc72c09 MK |
82 | On success, these |
83 | functions return the value \fIx\fP\ \-\ \fIn\fP*\fIy\fP, | |
022671eb MK |
84 | for some integer |
85 | .IR n , | |
1cc72c09 MK |
86 | such that the returned value has the same sign as |
87 | .I x | |
88 | and a magnitude less than the magnitude of | |
89 | .IR y . | |
847e0d88 | 90 | .PP |
1cc72c09 MK |
91 | If |
92 | .I x | |
93 | or | |
94 | .I y | |
95 | is a NaN, a NaN is returned. | |
847e0d88 | 96 | .PP |
1cc72c09 MK |
97 | If |
98 | .I x | |
385cf745 | 99 | is an infinity, |
efe294cb | 100 | a domain error occurs, and |
1cc72c09 | 101 | a NaN is returned. |
847e0d88 | 102 | .PP |
1cc72c09 MK |
103 | If |
104 | .I y | |
105 | is zero, | |
efe294cb | 106 | a domain error occurs, and |
1cc72c09 | 107 | a NaN is returned. |
847e0d88 | 108 | .PP |
1cc72c09 MK |
109 | If |
110 | .I x | |
111 | is +0 (\-0), and | |
112 | .I y | |
113 | is not zero, +0 (\-0) is returned. | |
fea681da | 114 | .SH ERRORS |
1cc72c09 MK |
115 | See |
116 | .BR math_error (7) | |
117 | for information on how to determine whether an error has occurred | |
118 | when calling these functions. | |
119 | .PP | |
120 | The following errors can occur: | |
121 | .TP | |
122 | Domain error: \fIx\fP is an infinity | |
9343357b MK |
123 | .I errno |
124 | is set to | |
125 | .BR EDOM | |
126 | (but see BUGS). | |
1cc72c09 MK |
127 | An invalid floating-point exception |
128 | .RB ( FE_INVALID ) | |
129 | is raised. | |
fea681da | 130 | .TP |
1cc72c09 MK |
131 | Domain error: \fIy\fP is zero |
132 | .I errno | |
133 | is set to | |
134 | .BR EDOM . | |
135 | An invalid floating-point exception | |
136 | .RB ( FE_INVALID ) | |
137 | is raised. | |
138 | .\" POSIX.1 documents an optional underflow error, but AFAICT it doesn't | |
139 | .\" (can't?) occur -- mtk, Jul 2008 | |
86576222 MS |
140 | .SH ATTRIBUTES |
141 | For an explanation of the terms used in this section, see | |
142 | .BR attributes (7). | |
143 | .TS | |
144 | allbox; | |
145 | lbw24 lb lb | |
146 | l l l. | |
147 | Interface Attribute Value | |
148 | T{ | |
149 | .BR fmod (), | |
150 | .BR fmodf (), | |
151 | .BR fmodl () | |
152 | T} Thread safety MT-Safe | |
153 | .TE | |
47297adb | 154 | .SH CONFORMING TO |
9a74e018 | 155 | C99, POSIX.1-2001, POSIX.1-2008. |
847e0d88 | 156 | .PP |
22cb459d MK |
157 | The variant returning |
158 | .I double | |
159 | also conforms to | |
160 | SVr4, 4.3BSD, C89. | |
9343357b MK |
161 | .SH BUGS |
162 | Before version 2.10, the glibc implementation did not set | |
163 | .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6784 | |
164 | .I errno | |
165 | to | |
166 | .B EDOM | |
167 | when a domain error occurred for an infinite | |
168 | .IR x . | |
47297adb | 169 | .SH SEE ALSO |
fea681da | 170 | .BR remainder (3) |