xref: /freebsd/lib/msun/man/round.3 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
1.\" Copyright (c) 2003, Steven G. Kargl
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd April 7, 2005
26.Dt ROUND 3
27.Os
28.Sh NAME
29.Nm round ,
30.Nm roundf ,
31.Nm roundl
32.Nd round to nearest integral value
33.Sh LIBRARY
34.Lb libm
35.Sh SYNOPSIS
36.In math.h
37.Ft double
38.Fn round "double x"
39.Ft float
40.Fn roundf "float x"
41.Ft "long double"
42.Fn roundl "long double x"
43.Sh DESCRIPTION
44The
45.Fn round ,
46.Fn roundf ,
47and
48.Fn roundl
49functions return the nearest integral value to
50.Fa x ;
51if
52.Fa x
53lies halfway between two integral values, then these
54functions return the integral value with the larger
55absolute value (i.e., they round away from zero).
56.Sh SEE ALSO
57.Xr ceil 3 ,
58.Xr floor 3 ,
59.Xr ieee 3 ,
60.Xr lrint 3 ,
61.Xr lround 3 ,
62.Xr math 3 ,
63.Xr rint 3 ,
64.Xr trunc 3
65.Sh STANDARDS
66These functions conform to
67.St -isoC-99 .
68.Sh HISTORY
69The
70.Fn round
71and
72.Fn roundf
73functions appeared in
74.Fx 5.3 .
75The
76.Fn roundl
77function appeared in
78.Fx 6.0 .
79