xref: /openbsd-src/lib/libm/man/rint.3 (revision 43003dfe3ad45d1698bed8a37f2b0f5b14f20d4f)
1.\"	$OpenBSD: rint.3,v 1.10 2009/08/03 21:26:07 martynas Exp $
2.\" Copyright (c) 1985, 1991 Regents of the University of California.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. Neither the name of the University nor the names of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\"     from: @(#)rint.3	5.1 (Berkeley) 5/2/91
30.\"
31.Dd $Mdocdate: August 3 2009 $
32.Dt RINT 3
33.Os
34.Sh NAME
35.Nm rint ,
36.Nm rintf ,
37.Nm rintl
38.Nd round to integral value in floating-point format
39.Sh SYNOPSIS
40.Fd #include <math.h>
41.Ft double
42.Fn rint "double x"
43.Ft float
44.Fn rintf "float x"
45.Ft long double
46.Fn rintl "long double x"
47.Sh DESCRIPTION
48The
49.Fn rint
50function returns the integral value (represented as a double precision number)
51nearest to
52.Fa x
53according to the prevailing rounding mode.
54The
55.Fn rintf
56function is a single precision version of
57.Fn rint .
58The
59.Fn rintl
60function is an extended precision version of
61.Fn rint .
62.Sh SEE ALSO
63.Xr abs 3 ,
64.Xr ceil 3 ,
65.Xr fabs 3 ,
66.Xr floor 3 ,
67.Xr math 3
68.Sh HISTORY
69A
70.Fn rint
71function appeared in
72.At v6 .
73