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