xref: /freebsd/lib/msun/man/fmod.3 (revision 7a15a32a17f4c2cbeb6f842c4c6b1cf93e4639e7)
1.\" Copyright (c) 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)fmod.3	5.1 (Berkeley) 5/2/91
33.\"	$Id: fmod.3,v 1.1.1.1 1994/08/19 09:39:42 jkh Exp $
34.\"
35.Dd May 2, 1991
36.Dt FMOD 3
37.Os
38.Sh NAME
39.Nm fmod ,
40.Nm fmodf
41.Nd floating-point remainder functions
42.Sh SYNOPSIS
43.Fd #include <math.h>
44.Ft double
45.Fn fmod "double x" "double y"
46.Ft float
47.Fn fmodf "float x" "float y"
48.Sh DESCRIPTION
49The
50.Fn fmod
51and the
52.Fn fmodf
53functions compute the floating-point remainder of
54.Fa x Ns / Fa y .
55.Sh RETURN VALUES
56The
57.Fn fmod
58and the
59.Fn fmodf
60functions return the value
61.Sm off
62.Fa x - Em i * Fa y ,
63.Sm on
64for some integer
65.Em i
66such that, if
67.Fa y
68is non-zero, the result has the same sign as
69.Fa x
70and magnitude less than the magnitude of
71.Fa y .
72If
73.Fa y
74is zero, whether a domain error occurs or the
75.Fn fmod
76and the
77.Fn fmodf
78function returns zero is implementation-defined.
79.Sh SEE ALSO
80.Xr math 3
81.Sh STANDARDS
82The
83.Fn fmod
84function conforms to
85.St -ansiC .
86