xref: /openbsd-src/lib/libm/man/fmod.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: fmod.3,v 1.5 2000/03/02 00:29:49 todd Exp $
2.\" Copyright (c) 1991 The Regents of the University of California.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. All advertising materials mentioning features or use of this software
14.\"    must display the following acknowledgement:
15.\"	This product includes software developed by the University of
16.\"	California, Berkeley and its contributors.
17.\" 4. Neither the name of the University nor the names of its contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"    without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\"     from: @(#)fmod.3	5.1 (Berkeley) 5/2/91
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
51function computes the floating-point remainder of
52.Fa x Ns / Fa y .
53.Sh RETURN VALUES
54The
55.Fn fmod
56and
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
74function returns zero is implementation-defined.
75.Sh SEE ALSO
76.Xr math 3
77.Sh STANDARDS
78The
79.Fn fmod
80function conforms to
81.St -ansiC .
82