xref: /freebsd/lib/msun/man/round.3 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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.\" $FreeBSD$
26.\"
27.Dd November 29, 2003
28.Dt ROUND 3
29.Os
30.Sh NAME
31.Nm round ,
32.Nm roundf
33.Nd round to nearest integral value
34.Sh LIBRARY
35.Lb libm
36.Sh SYNOPSIS
37.In math.h
38.Ft double
39.Fn round "double x"
40.Ft float
41.Fn roundf "float x"
42.Sh DESCRIPTION
43The
44.Fn round
45and
46.Fn roundf
47functions return the nearest integral value to
48.Fa x ;
49if
50.Fa x
51lies halfway between two integral values, then these
52functions return the integral value with the larger
53absolute value (i.e., they round away from zero).
54.Sh SEE ALSO
55.Xr ceil 3 ,
56.Xr floor 3 ,
57.Xr ieee 3 ,
58.Xr math 3 ,
59.Xr rint 3 ,
60.Xr trunc 3
61.Sh STANDARDS
62The
63.Fn round
64function conforms to
65.St -isoC-99 .
66.Sh HISTORY
67The
68.Fn round
69and
70.Fn roundf
71functions appeared in
72.Fx 5.3 .
73