overby.me
this repo has no description
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.\" $Id: rint.3,v 1.4 2004/12/20 21:35:46 scp Exp $
34.\"
35.Dd July 02, 2008
36.Dt RINT 3
37.Os
38.Sh NAME
39.Nm rint ,
40.Nm lrint ,
41.Nm llrint
42.Nd round to integral value
43.Sh SYNOPSIS
44.Fd #include <math.h>
45.Ft double
46.Fn rint "double x"
47.Ft long double
48.Fn rintl "long double x"
49.Ft float
50.Fn rintf "float x"
51.Ft long int
52.Fn lrint "double x"
53.Ft long int
54.Fn lrintl "long double x"
55.Ft long int
56.Fn lrintf "float x"
57.Ft long long int
58.Fn llrint "double x"
59.Ft long long int
60.Fn llrintl "long double x"
61.Ft long long int
62.Fn llrintf "float x"
63.Sh DESCRIPTION
64The
65.Fn rint
66functions return the integral value
67nearest to
68.Fa x
69(according to the prevailing rounding mode) in floating-point format.
70.Pp
71The
72.Fn lrint
73and
74.Fn llrint
75functions return the integral value nearest to
76.Fa x
77(according to the prevailing rounding mode) in the return formats specified. If the rounded
78value is outside the range of the return type, the numeric result is unspecified and the
79"invalid" floating-point exception is raised. A range error may occur if the magnitude of
80.Fa x
81is too large.
82.Sh SPECIAL VALUES
83.Fn rint "�0"
84returns �0 for all rounding modes.
85.Pp
86.Fn rint "�infinity"
87returns �infinity for all rounding modes.
88.Pp
89All these functions raise the "inexact" floating-point exception if the result differs in
90value from the argument (except when they raise some other floating-point exception, such as "invalid").
91.Sh NOTE
92The
93.Fn rinttol
94function is deprecated. Please use the C99 function
95.Fn lrint
96instead.
97.Sh SEE ALSO
98.Xr abs 3 ,
99.Xr fabs 3 ,
100.Xr ceil 3 ,
101.Xr floor 3 ,
102.Xr math 3
103.Sh STANDARDS
104The
105.Fn rint
106,
107.Fn lrint
108, and
109.Fn llrint
110functions conform to ISO/IEC 9899:1999(E).