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