xref: /minix/lib/libm/man/fmod.3 (revision ebfedea0)
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.12 2013/11/12 16:48:39 joerg Exp $
30.\"
31.Dd November 12, 2013
32.Dt FMOD 3
33.Os
34.Sh NAME
35.Nm fmod ,
36.Nm fmodf ,
37.Nm fmodl
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.Ft long double
48.Fn fmodl "long double x" "long double y"
49.Sh DESCRIPTION
50The
51.Fn fmod
52function computes the floating-point remainder of
53.Fa x Ns / Fa y .
54.Sh RETURN VALUES
55The
56.Fn fmod ,
57.Fn fmodf ,
58and
59.Fn fmodl
60functions return the value
61.Sm off
62.Fa x - Em i * Fa y ,
63.Sm on
64for some integer
65.Em i
66such that, if
67.Fa y
68is non-zero, the result has the same sign as
69.Fa x
70and magnitude less than the magnitude of
71.Fa y .
72If
73.Fa y
74is zero, whether a domain error occurs or the
75.Fn fmod
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 -ansiC .
84