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