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