xref: /dragonfly/contrib/openbsd_libm/man/floor.3 (revision 1975d09e)
1.\"	$OpenBSD: floor.3,v 1.14 2013/07/17 05:42:11 schwarze Exp $
2.\" Copyright (c) 1985, 1991 The Regents of the University of California.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. Neither the name of the University nor the names of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\"     from: @(#)floor.3	6.5 (Berkeley) 4/19/91
30.\"
31.Dd $Mdocdate: July 17 2013 $
32.Dt FLOOR 3
33.Os
34.Sh NAME
35.Nm floor ,
36.Nm floorf ,
37.Nm floorl
38.Nd round to largest integral value not greater than x
39.Sh SYNOPSIS
40.In math.h
41.Ft double
42.Fn floor "double x"
43.Ft float
44.Fn floorf "float x"
45.Ft long double
46.Fn floorl "long double x"
47.Sh DESCRIPTION
48The
49.Fn floor
50function returns the largest integral value
51less than or equal to
52.Fa x .
53The
54.Fn floorf
55function is a single precision version of
56.Fn floor .
57The
58.Fn floorl
59function is an extended precision version of
60.Fn floor .
61.Sh SEE ALSO
62.Xr abs 3 ,
63.Xr ceil 3 ,
64.Xr fabs 3 ,
65.Xr nextafter 3 ,
66.Xr rint 3
67.Sh STANDARDS
68The
69.Fn floor
70function conforms to
71.St -ansiC .
72.Sh HISTORY
73A
74.Fn floor
75function first appeared in
76.At v5 .
77