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