xref: /dflybsd-src/contrib/openbsd_libm/man/lrint.3 (revision 4382f29d99a100bd77a81697c2f699c11f6a472a)
1*05a0b428SJohn Marino.\" 	$OpenBSD: lrint.3,v 1.4 2011/07/07 01:34:52 martynas Exp $
2*05a0b428SJohn Marino.\" $NetBSD: lrint.3,v 1.1 2005/09/16 15:26:47 wiz Exp $
3*05a0b428SJohn Marino.\"
4*05a0b428SJohn Marino.\" Copyright (c) 2005 David Schultz <das@FreeBSD.org>
5*05a0b428SJohn Marino.\" All rights reserved.
6*05a0b428SJohn Marino.\"
7*05a0b428SJohn Marino.\" Redistribution and use in source and binary forms, with or without
8*05a0b428SJohn Marino.\" modification, are permitted provided that the following conditions
9*05a0b428SJohn Marino.\" are met:
10*05a0b428SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
11*05a0b428SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
12*05a0b428SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
13*05a0b428SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
14*05a0b428SJohn Marino.\"    documentation and/or other materials provided with the distribution.
15*05a0b428SJohn Marino.\"
16*05a0b428SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17*05a0b428SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*05a0b428SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*05a0b428SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20*05a0b428SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*05a0b428SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*05a0b428SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*05a0b428SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*05a0b428SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*05a0b428SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*05a0b428SJohn Marino.\" SUCH DAMAGE.
27*05a0b428SJohn Marino.\"
28*05a0b428SJohn Marino.\" $FreeBSD: /repoman/r/ncvs/src/lib/msun/man/lrint.3,v 1.2.2.2 2005/03/01 16:18:39 brueffer Exp $
29*05a0b428SJohn Marino.\"
30*05a0b428SJohn Marino.Dd $Mdocdate: July 7 2011 $
31*05a0b428SJohn Marino.Dt LRINT 3
32*05a0b428SJohn Marino.Os
33*05a0b428SJohn Marino.Sh NAME
34*05a0b428SJohn Marino.Nm llrint ,
35*05a0b428SJohn Marino.Nm llrintf ,
36*05a0b428SJohn Marino.Nm llrintl ,
37*05a0b428SJohn Marino.Nm lrint ,
38*05a0b428SJohn Marino.Nm lrintf ,
39*05a0b428SJohn Marino.Nm lrintl
40*05a0b428SJohn Marino.Nd convert to integer
41*05a0b428SJohn Marino.Sh SYNOPSIS
42*05a0b428SJohn Marino.In math.h
43*05a0b428SJohn Marino.Ft long long
44*05a0b428SJohn Marino.Fn llrint "double x"
45*05a0b428SJohn Marino.Ft long long
46*05a0b428SJohn Marino.Fn llrintf "float x"
47*05a0b428SJohn Marino.Ft long long
48*05a0b428SJohn Marino.Fn llrintl "long double x"
49*05a0b428SJohn Marino.Ft long
50*05a0b428SJohn Marino.Fn lrint "double x"
51*05a0b428SJohn Marino.Ft long
52*05a0b428SJohn Marino.Fn lrintf "float x"
53*05a0b428SJohn Marino.Ft long
54*05a0b428SJohn Marino.Fn lrintl "long double x"
55*05a0b428SJohn Marino.Sh DESCRIPTION
56*05a0b428SJohn MarinoThe
57*05a0b428SJohn Marino.Fn lrint
58*05a0b428SJohn Marinofunction returns the integer nearest to its argument
59*05a0b428SJohn Marino.Fa x
60*05a0b428SJohn Marinoaccording to the current rounding mode.
61*05a0b428SJohn Marino.Pp
62*05a0b428SJohn MarinoThe
63*05a0b428SJohn Marino.Fn llrint ,
64*05a0b428SJohn Marino.Fn llrintf ,
65*05a0b428SJohn Marino.Fn llrintl ,
66*05a0b428SJohn Marino.Fn lrintf ,
67*05a0b428SJohn Marinoand
68*05a0b428SJohn Marino.Fn lrintl
69*05a0b428SJohn Marinofunctions differ from
70*05a0b428SJohn Marino.Fn lrint
71*05a0b428SJohn Marinoonly in their input and output types.
72*05a0b428SJohn Marino.Sh RETURN VALUES
73*05a0b428SJohn MarinoThe
74*05a0b428SJohn Marino.Nm llrint ,
75*05a0b428SJohn Marino.Nm llrintf ,
76*05a0b428SJohn Marino.Nm llrintl ,
77*05a0b428SJohn Marino.Nm lrint ,
78*05a0b428SJohn Marino.Nm lrintf ,
79*05a0b428SJohn Marinoand
80*05a0b428SJohn Marino.Nm lrintl
81*05a0b428SJohn Marinofunctions return the integer nearest to their argument
82*05a0b428SJohn Marino.Fa x
83*05a0b428SJohn Marinoaccording to the current rounding mode.
84*05a0b428SJohn MarinoIf the rounded result is too large to be represented as a
85*05a0b428SJohn Marino.Vt long long
86*05a0b428SJohn Marinoor
87*05a0b428SJohn Marino.Vt long
88*05a0b428SJohn Marinovalue, respectively,
89*05a0b428SJohn Marino.\" an invalid exception is raised and
90*05a0b428SJohn Marinothe return value is undefined.
91*05a0b428SJohn Marino.\" Otherwise, if
92*05a0b428SJohn Marino.\" .Fa x
93*05a0b428SJohn Marino.\" is not an integer,
94*05a0b428SJohn Marino.\" .Fn lrint
95*05a0b428SJohn Marino.\" raises an inexact exception.
96*05a0b428SJohn Marino.\" If
97*05a0b428SJohn Marino.\" .Fa x
98*05a0b428SJohn Marino.\" is too large, a range error may occur.
99*05a0b428SJohn Marino.Sh SEE ALSO
100*05a0b428SJohn Marino.Xr lround 3 ,
101*05a0b428SJohn Marino.Xr rint 3
102*05a0b428SJohn Marino.Sh STANDARDS
103*05a0b428SJohn MarinoThe
104*05a0b428SJohn Marino.Fn llrint ,
105*05a0b428SJohn Marino.Fn llrintf ,
106*05a0b428SJohn Marino.Fn llrintl ,
107*05a0b428SJohn Marino.Fn lrint ,
108*05a0b428SJohn Marino.Fn lrintf ,
109*05a0b428SJohn Marinoand
110*05a0b428SJohn Marino.Fn lrintl
111*05a0b428SJohn Marinofunctions conform to
112*05a0b428SJohn Marino.St -isoC-99 .
113