Start development on 386BSD 0.0
[unix-history] / .ref-BSD-4_3_Net_2 / usr / src / lib / libm / common_source / fmod.3
CommitLineData
af359dea
C
1.\" Copyright (c) 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
c0567266
KB
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.
af359dea
C
31.\"
32.\" @(#)fmod.3 5.1 (Berkeley) 5/2/91
33.\"
34.Dd May 2, 1991
35.Dt FMOD 3
36.Os
37.Sh NAME
38.Nm fmod
39.Nd floating-point remainder function
40.Sh SYNOPSIS
41.Fd #include <math.h>
42.Ft double
43.Fn fmod "double x" "double y"
44.Sh DESCRIPTION
45The
46.Fn fmod
47function computes the floating-point remainder of
48.Fa x Ns / Fa y .
49.Sh RETURN VALUES
50The
51.Fn fmod
52function returns the value
53.Sm off
54.Fa x - Em i * Fa y ,
55.Sm on
56for some integer
57.Em i
58such that, if
59.Fa y
60is non-zero, the result has the same sign as
61.Fa x
62and magnitude less than the magnitude of
63.Fa y .
64If
65.Fa y
66is zero, whether a domain error occurs or the
67.Fn fmod
68function returns zero is implementation-defined.
69.Sh SEE ALSO
70.Xr math 3
71.Sh STANDARDS
72The
73.Fn fmod
74function conforms to
75.St -ansiC .