xref: /dflybsd-src/contrib/openbsd_libm/man/fmod.3 (revision 4382f29d99a100bd77a81697c2f699c11f6a472a)
1*05a0b428SJohn Marino.\"	$OpenBSD: fmod.3,v 1.12 2013/07/17 05:42:11 schwarze Exp $
2*05a0b428SJohn Marino.\" Copyright (c) 1991 The Regents of the University of California.
3*05a0b428SJohn Marino.\" All rights reserved.
4*05a0b428SJohn Marino.\"
5*05a0b428SJohn Marino.\" Redistribution and use in source and binary forms, with or without
6*05a0b428SJohn Marino.\" modification, are permitted provided that the following conditions
7*05a0b428SJohn Marino.\" are met:
8*05a0b428SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
9*05a0b428SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
10*05a0b428SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
11*05a0b428SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
12*05a0b428SJohn Marino.\"    documentation and/or other materials provided with the distribution.
13*05a0b428SJohn Marino.\" 3. Neither the name of the University nor the names of its contributors
14*05a0b428SJohn Marino.\"    may be used to endorse or promote products derived from this software
15*05a0b428SJohn Marino.\"    without specific prior written permission.
16*05a0b428SJohn Marino.\"
17*05a0b428SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18*05a0b428SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19*05a0b428SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20*05a0b428SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21*05a0b428SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*05a0b428SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23*05a0b428SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24*05a0b428SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25*05a0b428SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26*05a0b428SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27*05a0b428SJohn Marino.\" SUCH DAMAGE.
28*05a0b428SJohn Marino.\"
29*05a0b428SJohn Marino.\"     from: @(#)fmod.3	5.1 (Berkeley) 5/2/91
30*05a0b428SJohn Marino.\"
31*05a0b428SJohn Marino.Dd $Mdocdate: July 17 2013 $
32*05a0b428SJohn Marino.Dt FMOD 3
33*05a0b428SJohn Marino.Os
34*05a0b428SJohn Marino.Sh NAME
35*05a0b428SJohn Marino.Nm fmod ,
36*05a0b428SJohn Marino.Nm fmodf ,
37*05a0b428SJohn Marino.Nm fmodl
38*05a0b428SJohn Marino.Nd floating-point remainder functions
39*05a0b428SJohn Marino.Sh SYNOPSIS
40*05a0b428SJohn Marino.In math.h
41*05a0b428SJohn Marino.Ft double
42*05a0b428SJohn Marino.Fn fmod "double x" "double y"
43*05a0b428SJohn Marino.Ft float
44*05a0b428SJohn Marino.Fn fmodf "float x" "float y"
45*05a0b428SJohn Marino.Ft long double
46*05a0b428SJohn Marino.Fn fmodl "long double x" "long double y"
47*05a0b428SJohn Marino.Sh DESCRIPTION
48*05a0b428SJohn MarinoThe
49*05a0b428SJohn Marino.Fn fmod
50*05a0b428SJohn Marinofunction computes the floating-point remainder of
51*05a0b428SJohn Marino.Fa x Ns / Fa y .
52*05a0b428SJohn MarinoThe
53*05a0b428SJohn Marino.Fn fmodf
54*05a0b428SJohn Marinofunction is a single precision version of
55*05a0b428SJohn Marino.Fn fmod .
56*05a0b428SJohn MarinoThe
57*05a0b428SJohn Marino.Fn fmodl
58*05a0b428SJohn Marinofunction is an extended precision version of
59*05a0b428SJohn Marino.Fn fmod .
60*05a0b428SJohn Marino.Sh RETURN VALUES
61*05a0b428SJohn MarinoThe
62*05a0b428SJohn Marino.Fn fmod ,
63*05a0b428SJohn Marino.Fn fmodf
64*05a0b428SJohn Marinoand
65*05a0b428SJohn Marino.Fn fmodl
66*05a0b428SJohn Marinofunctions return the value
67*05a0b428SJohn Marino.Sm off
68*05a0b428SJohn Marino.Fa x - Em i * Fa y ,
69*05a0b428SJohn Marino.Sm on
70*05a0b428SJohn Marinofor some integer
71*05a0b428SJohn Marino.Em i
72*05a0b428SJohn Marinosuch that, if
73*05a0b428SJohn Marino.Fa y
74*05a0b428SJohn Marinois non-zero, the result has the same sign as
75*05a0b428SJohn Marino.Fa x
76*05a0b428SJohn Marinoand magnitude less than the magnitude of
77*05a0b428SJohn Marino.Fa y .
78*05a0b428SJohn MarinoIf
79*05a0b428SJohn Marino.Fa y
80*05a0b428SJohn Marinois zero, whether a domain error occurs or the
81*05a0b428SJohn Marino.Fn fmod
82*05a0b428SJohn Marinofunction returns zero is implementation-defined.
83*05a0b428SJohn Marino.Sh SEE ALSO
84*05a0b428SJohn Marino.Xr remainder 3
85*05a0b428SJohn Marino.Sh STANDARDS
86*05a0b428SJohn MarinoThe
87*05a0b428SJohn Marino.Fn fmod
88*05a0b428SJohn Marinofunction conforms to
89*05a0b428SJohn Marino.St -ansiC .
90*05a0b428SJohn Marino.Sh HISTORY
91*05a0b428SJohn MarinoAn
92*05a0b428SJohn Marino.Fn fmod
93*05a0b428SJohn Marinofunction first appeared in
94*05a0b428SJohn Marino.At v5 .
95