xref: /freebsd/lib/msun/man/rint.3 (revision 4e579ad047720775ab580b74192c7de8a3386fea)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     from: @(#)rint.3	5.1 (Berkeley) 5/2/91
29.\"
30.Dd January 13, 2008
31.Dt RINT 3
32.Os
33.Sh NAME
34.Nm nearbyint ,
35.Nm nearbyintf ,
36.Nm nearbyintl ,
37.Nm rint ,
38.Nm rintf ,
39.Nm rintl
40.Nd round to integral value in floating-point format
41.Sh LIBRARY
42.Lb libm
43.Sh SYNOPSIS
44.In math.h
45.Ft double
46.Fn nearbyint "double x"
47.Ft float
48.Fn nearbyintf "float x"
49.Ft long double
50.Fn nearbyintl "long double x"
51.Ft double
52.Fn rint "double x"
53.Ft float
54.Fn rintf "float x"
55.Ft long double
56.Fn rintl "long double x"
57.Sh DESCRIPTION
58The
59.Fn rint ,
60.Fn rintf ,
61and
62.Fn rintl
63functions return the integral value nearest to
64.Fa x
65according to the prevailing rounding mode.
66These functions raise an inexact exception when the original argument
67is not an exact integer.
68.Pp
69The
70.Fn nearbyint ,
71.Fn nearbyintf ,
72and
73.Fn nearbyintl
74functions perform the same operation, except that they do not raise
75an inexact exception.
76.Sh SEE ALSO
77.Xr abs 3 ,
78.Xr ceil 3 ,
79.Xr fabs 3 ,
80.Xr fenv 3 ,
81.Xr floor 3 ,
82.Xr ieee 3 ,
83.Xr lrint 3 ,
84.Xr lround 3 ,
85.Xr math 3 ,
86.Xr round 3
87.Sh STANDARDS
88These functions conform to
89.St -isoC-99 .
90.Sh HISTORY
91A
92.Fn rint
93function appeared in
94.At v6 .
95The
96.Fn nearbyint
97and
98.Fn nearbyintf
99functions appeared in
100.Fx 5.3 ,
101and the long double variants were first available in
102.Fx 8.0 .
103