xref: /freebsd/lib/msun/man/fmod.3 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.\"
30.Dd April 3, 2022
31.Dt FMOD 3
32.Os
33.Sh NAME
34.Nm fmod ,
35.Nm fmodf ,
36.Nm fmodl
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.Ft long double
47.Fn fmodl "long double x" "long double y"
48.Sh DESCRIPTION
49The
50.Fn fmod ,
51.Fn fmodf ,
52and
53.Fn fmodl
54functions compute the floating-point remainder of
55.Fa x Ns / Fa y .
56.Sh RETURN VALUES
57If
58.Fa y
59is non-zero, the
60.Fn fmod ,
61.Fn fmodf ,
62and
63.Fn fmodl
64functions return the value
65.Sm off
66.Fa x - Em i * Fa y ,
67.Sm on
68for some integer
69.Em i ,
70such that the result has the same sign as
71.Fa x
72and magnitude less than the magnitude of
73.Fa y .
74If
75.Fa y
76is zero, a \*(Na is produced.
77.Sh SEE ALSO
78.Xr math 3
79.Sh STANDARDS
80The
81.Fn fmod ,
82.Fn fmodf ,
83and
84.Fn fmodl
85functions conform to
86.St -isoC-99 .
87.Sh HISTORY
88An
89.Fn fmod
90function first appeared in
91.At v5 .
92