Merge from vendor branch LIBSTDC++:
[dragonfly.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 .\" $DragonFly: src/lib/msun/man/Attic/rint.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
35 .\"
36 .Dd March 10, 1994
37 .Dt RINT 3
38 .Os
39 .Sh NAME
40 .Nm rint ,
41 .Nm rintf
42 .Nd round to integral value in floating-point format
43 .Sh LIBRARY
44 .Lb libm
45 .Sh SYNOPSIS
46 .In math.h
47 .Ft double
48 .Fn rint "double x"
49 .Ft float
50 .Fn rintf "float x"
51 .Sh DESCRIPTION
52 The
53 .Fn rint
54 and the
55 .Fn rintf
56 functions return the integral value (represented as a double or float
57 precision number) nearest to
58 .Fa x
59 according to the prevailing rounding mode.
60 .Sh SEE ALSO
61 .Xr abs 3 ,
62 .Xr ceil 3 ,
63 .Xr fabs 3 ,
64 .Xr floor 3 ,
65 .Xr ieee 3 ,
66 .Xr math 3
67 .Sh HISTORY
68 A
69 .Fn rint
70 function appeared in
71 .At v6 .