xref: /openbsd-src/lib/libm/man/fmod.3 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\"	$OpenBSD: fmod.3,v 1.8 2007/05/31 19:19:35 jmc 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. Neither the name of the University nor the names of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\"     from: @(#)fmod.3	5.1 (Berkeley) 5/2/91
30.\"
31.Dd $Mdocdate: May 31 2007 $
32.Dt FMOD 3
33.Os
34.Sh NAME
35.Nm fmod ,
36.Nm fmodf
37.Nd floating-point remainder functions
38.Sh SYNOPSIS
39.Fd #include <math.h>
40.Ft double
41.Fn fmod "double x" "double y"
42.Ft float
43.Fn fmodf "float x" "float y"
44.Sh DESCRIPTION
45The
46.Fn fmod
47function computes the floating-point remainder of
48.Fa x Ns / Fa y .
49The
50.Fn fmodf
51function is a single precision version of
52.Fn fmod .
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