Initial import from FreeBSD RELENG_4:
[games.git] / lib / msun / man / rint.3
1 .\" Copyright (c) 1985, 1991 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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     from: @(#)rint.3        5.1 (Berkeley) 5/2/91
33 .\" $FreeBSD: src/lib/msun/man/rint.3,v 1.6.2.2 2001/12/17 10:08:36 ru Exp $
34 .\"
35 .Dd March 10, 1994
36 .Dt RINT 3
37 .Os
38 .Sh NAME
39 .Nm rint ,
40 .Nm rintf
41 .Nd round to integral value in floating-point format
42 .Sh LIBRARY
43 .Lb libm
44 .Sh SYNOPSIS
45 .In math.h
46 .Ft double
47 .Fn rint "double x"
48 .Ft float
49 .Fn rintf "float x"
50 .Sh DESCRIPTION
51 The
52 .Fn rint
53 and the
54 .Fn rintf
55 functions return the integral value (represented as a double or float
56 precision number) nearest to
57 .Fa x
58 according to the prevailing rounding mode.
59 .Sh SEE ALSO
60 .Xr abs 3 ,
61 .Xr ceil 3 ,
62 .Xr fabs 3 ,
63 .Xr floor 3 ,
64 .Xr ieee 3 ,
65 .Xr math 3
66 .Sh HISTORY
67 A
68 .Fn rint
69 function appeared in
70 .At v6 .