MFC:
[dragonfly.git] / lib / libm / man / fmod.3
blob0a592d03067ec57608d1a10e748008dff9c8c50e
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. 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 .\"     $NetBSD: fmod.3,v 1.11 2003/08/07 16:44:47 agc Exp $
30 .\"     $DragonFly: src/lib/libm/man/fmod.3,v 1.1 2005/07/26 21:15:20 joerg Exp $
31 .\"
32 .Dd May 2, 1991
33 .Dt FMOD 3
34 .Os
35 .Sh NAME
36 .Nm fmod ,
37 .Nm fmodf
38 .Nd floating-point remainder function
39 .Sh LIBRARY
40 .Lb libm
41 .Sh SYNOPSIS
42 .In math.h
43 .Ft double
44 .Fn fmod "double x" "double y"
45 .Ft float
46 .Fn fmodf "float x" "float y"
47 .Sh DESCRIPTION
48 The
49 .Fn fmod
50 function computes the floating-point remainder of
51 .Fa x Ns / Fa y .
52 .Sh RETURN VALUES
53 The
54 .Fn fmod
55 and
56 .Fn fmodf
57 functions return the value
58 .Sm off
59 .Fa x - Em i * Fa y ,
60 .Sm on
61 for some integer
62 .Em i
63 such that, if
64 .Fa y
65 is non-zero, the result has the same sign as
66 .Fa x
67 and magnitude less than the magnitude of
68 .Fa y .
70 .Fa y
71 is zero, whether a domain error occurs or the
72 .Fn fmod
73 function returns zero is implementation-defined.
74 .Sh SEE ALSO
75 .Xr math 3
76 .Sh STANDARDS
77 The
78 .Fn fmod
79 function conforms to
80 .St -ansiC .