xref: /freebsd/lib/msun/man/fmod.3 (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
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.\" 4. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     from: @(#)fmod.3	5.1 (Berkeley) 5/2/91
29.\" $FreeBSD$
30.\"
31.Dd May 2, 1991
32.Dt FMOD 3
33.Os
34.Sh NAME
35.Nm fmod ,
36.Nm fmodf
37.Nd floating-point remainder functions
38.Sh LIBRARY
39.Lb libm
40.Sh SYNOPSIS
41.In math.h
42.Ft double
43.Fn fmod "double x" "double y"
44.Ft float
45.Fn fmodf "float x" "float y"
46.Sh DESCRIPTION
47The
48.Fn fmod
49and the
50.Fn fmodf
51functions compute the floating-point remainder of
52.Fa x Ns / Fa y .
53.Sh RETURN VALUES
54The
55.Fn fmod
56and the
57.Fn fmodf
58functions return the value
59.Sm off
60.Fa x - Em i * Fa y ,
61.Sm on
62for some integer
63.Em i
64such that, if
65.Fa y
66is non-zero, the result has the same sign as
67.Fa x
68and magnitude less than the magnitude of
69.Fa y .
70If
71.Fa y
72is zero, whether a domain error occurs or the
73.Fn fmod
74and the
75.Fn fmodf
76function returns zero is implementation-defined.
77.Sh SEE ALSO
78.Xr math 3
79.Sh STANDARDS
80The
81.Fn fmod
82function conforms to
83.St -isoC .
84