xref: /freebsd/lib/msun/man/rint.3 (revision aa1a8ff2d6dbc51ef058f46f3db5a8bb77967145)
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.Dd January 13, 2008
29.Dt RINT 3
30.Os
31.Sh NAME
32.Nm nearbyint ,
33.Nm nearbyintf ,
34.Nm nearbyintl ,
35.Nm rint ,
36.Nm rintf ,
37.Nm rintl
38.Nd round to integral value in floating-point format
39.Sh LIBRARY
40.Lb libm
41.Sh SYNOPSIS
42.In math.h
43.Ft double
44.Fn nearbyint "double x"
45.Ft float
46.Fn nearbyintf "float x"
47.Ft long double
48.Fn nearbyintl "long double x"
49.Ft double
50.Fn rint "double x"
51.Ft float
52.Fn rintf "float x"
53.Ft long double
54.Fn rintl "long double x"
55.Sh DESCRIPTION
56The
57.Fn rint ,
58.Fn rintf ,
59and
60.Fn rintl
61functions return the integral value nearest to
62.Fa x
63according to the prevailing rounding mode.
64These functions raise an inexact exception when the original argument
65is not an exact integer.
66.Pp
67The
68.Fn nearbyint ,
69.Fn nearbyintf ,
70and
71.Fn nearbyintl
72functions perform the same operation, except that they do not raise
73an inexact exception.
74.Sh SEE ALSO
75.Xr abs 3 ,
76.Xr ceil 3 ,
77.Xr fabs 3 ,
78.Xr fenv 3 ,
79.Xr floor 3 ,
80.Xr ieee 3 ,
81.Xr lrint 3 ,
82.Xr lround 3 ,
83.Xr math 3 ,
84.Xr round 3
85.Sh STANDARDS
86These functions conform to
87.St -isoC-99 .
88.Sh HISTORY
89A
90.Fn rint
91function appeared in
92.At v6 .
93The
94.Fn nearbyint
95and
96.Fn nearbyintf
97functions appeared in
98.Fx 5.3 ,
99and the long double variants were first available in
100.Fx 8.0 .
101