xref: /freebsd/lib/msun/man/floor.3 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1.\" Copyright (c) 1985, 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.Dd April 3, 2022
29.Dt FLOOR 3
30.Os
31.Sh NAME
32.Nm floor ,
33.Nm floorf ,
34.Nm floorl
35.Nd largest integral value less than or equal to x
36.Sh LIBRARY
37.Lb libm
38.Sh SYNOPSIS
39.In math.h
40.Ft double
41.Fn floor "double x"
42.Ft float
43.Fn floorf "float x"
44.Ft "long double"
45.Fn floorl "long double x"
46.Sh DESCRIPTION
47The
48.Fn floor ,
49.Fn floorf
50and
51.Fn floorl
52functions return the largest integral value
53less than or equal to
54.Fa x ,
55expressed as a floating-point number.
56.Sh SEE ALSO
57.Xr abs 3 ,
58.Xr ceil 3 ,
59.Xr fabs 3 ,
60.Xr ieee 3 ,
61.Xr math 3 ,
62.Xr rint 3 ,
63.Xr round 3 ,
64.Xr trunc 3
65.Sh STANDARDS
66The
67.Fn floor
68function conforms to
69.St -isoC .
70The
71.Fn floorf
72and
73.Fn floorl
74functions conform to
75.St -isoC-99 .
76.Sh HISTORY
77A
78.Fn floor
79function first appeared in
80.At v5 .
81