1d1519750a07c8ae604168e3195a38ae3699d126
[dragonfly.git] / lib / libm / man / round.3
1 .\" $NetBSD: round.3,v 1.6 2011/09/13 07:11:43 njoly Exp $
2 .\"
3 .\" Copyright (c) 2003, Steven G. Kargl
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/lib/msun/man/round.3,v 1.2 2004/06/20 09:27:17 das Exp $
28 .\"
29 .Dd July 15, 2004
30 .Dt ROUND 3
31 .Os
32 .Sh NAME
33 .Nm round ,
34 .Nm roundf
35 .Nd round to nearest integral value
36 .Sh LIBRARY
37 .Lb libm
38 .Sh SYNOPSIS
39 .In math.h
40 .Ft double
41 .Fn round "double x"
42 .Ft float
43 .Fn roundf "float x"
44 .Sh DESCRIPTION
45 The
46 .Fn round
47 and
48 .Fn roundf
49 functions return the nearest integral value to
50 .Fa x ;
51 if
52 .Fa x
53 lies halfway between two integral values, then these
54 functions return the integral value with the larger
55 absolute value (i.e., they round away from zero).
56 .Sh SEE ALSO
57 .Xr ceil 3 ,
58 .Xr floor 3 ,
59 .Xr math 3 ,
60 .Xr rint 3 ,
61 .Xr trunc 3
62 .Sh STANDARDS
63 The
64 .Fn round
65 and
66 .Fn roundf
67 functions conform to
68 .St -isoC-99 .
69 .Sh HISTORY
70 The
71 .Fn round
72 and
73 .Fn roundf
74 functions appeared in
75 .Nx 2.0 .