this repo has no description
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. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" from: @(#)fmod.3 5.1 (Berkeley) 5/2/91
33.\" $Id: remainder.3,v 1.4 2004/12/20 21:35:46 scp Exp $
34.\"
35.Dd July 02, 2008
36.Dt REMAINDER 3
37.Os
38.Sh NAME
39.Nm remainder
40.Nd floating-point remainder function
41.Sh SYNOPSIS
42.Fd #include <math.h>
43.Ft double
44.Fn remainder "double x" "double y"
45.Ft long double
46.Fn remainderl "long double x" "long double y"
47.Ft float
48.Fn remainderf "float x" "float y"
49.Sh DESCRIPTION
50The
51.Fn remainder
52functions compute the value r such that r = x - n*y, where n is the integer nearest the exact value of x/y.
53.Pp
54If there are two integers closest to x/y, n shall be the even one. If r is zero, it is given the same sign as x.
55.Sh SPECIAL VALUES
56.Fn remainder "x, y"
57returns a NaN and raises the "invalid" floating-point exception if x is infinite or y is 0.
58.Sh NOTE
59The
60.Fn drem
61function is deprecated. Please use the C99 function
62.Fn remainder
63instead.
64.Sh SEE ALSO
65.Xr math 3
66.Sh STANDARDS
67The
68.Fn remainder
69functions conform to ISO/IEC 9899:1999(E).