Document [l]lrint[f]() and [l]lround[f]().

This commit is contained in:
David Schultz 2005-01-11 23:12:17 +00:00
parent 439e59cf85
commit 2aac156d2e
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=140087
5 changed files with 197 additions and 5 deletions

94
lib/msun/man/lrint.3 Normal file
View File

@ -0,0 +1,94 @@
.\" Copyright (c) 2005 David Schultz <das@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 11, 2005
.Dt LRINT 3
.Os
.Sh NAME
.Nm llrint ,
.Nm llrintf ,
.Nm lrint ,
.Nm lrintf
.Nd convert to integer
.Sh LIBRARY
.Lb libm
.Sh SYNOPSIS
.In math.h
.Ft long long
.Fn llrint "double x"
.Ft long long
.Fn llrintf "float x"
.Ft long
.Fn lrint "double x"
.Ft long
.Fn lrintf "float x"
.Sh DESCRIPTION
The
.Fn lrint
function returns the integer nearest to its argument
.Fa x
according to the current rounding mode.
If the rounded result is too large to be represented as a
.Ft long
value, an invalid exception is raised and the return value is undefined.
Otherwise, if
.Fa x
is not an integer,
.Fn lrint
raises an inexact exception.
When the rounded result is representable as a
.Ft long ,
the expression
.Li lrint(x)
is equivalent to
.Li (long)rint(x)
(although the former may be more efficient.)
.Pp
The
.Fn llrint ,
.Fn llrintf ,
and
.Fn lrintf
functions differ from
.Fn lrint
only in their input and output types.
.Sh SEE ALSO
.Xr lround 3 ,
.Xr math 3 ,
.Xr rint 3 ,
.Xr round 3
.Sh STANDARDS
The
.Fn llrint ,
.Fn llrintf ,
.Fn lrint ,
and
.Fn lrintf
functions conform to
.St -isoC-99 .
.Sh HISTORY
These routines first appeared in
.Fx 5.4 .

94
lib/msun/man/lround.3 Normal file
View File

@ -0,0 +1,94 @@
.\" Copyright (c) 2005 David Schultz <das@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 11, 2005
.Dt LROUND 3
.Os
.Sh NAME
.Nm llround ,
.Nm llroundf ,
.Nm lround ,
.Nm lroundf
.Nd convert to nearest integral value
.Sh LIBRARY
.Lb libm
.Sh SYNOPSIS
.In math.h
.Ft long long
.Fn llround "double x"
.Ft long long
.Fn llroundf "float x"
.Ft long
.Fn lround "double x"
.Ft long
.Fn lroundf "float x"
.Sh DESCRIPTION
The
.Fn lround
function returns the integer nearest to its argument
.Fa x ,
rounding away from zero in halfway cases.
If the rounded result is too large to be represented as a
.Ft long
value, an invalid exception is raised and the return value is undefined.
Otherwise, if
.Fa x
is not an integer,
.Fn lround
may raise an inexact exception.
When the rounded result is representable as a
.Ft long ,
the expression
.Li lround(x)
is equivalent to
.Li (long)round(x)
(although the former may be more efficient.)
.Pp
The
.Fn llround ,
.Fn llroundf ,
and
.Fn lroundf
functions differ from
.Fn lround
only in their input and output types.
.Sh SEE ALSO
.Xr lrint 3 ,
.Xr math 3 ,
.Xr rint 3 ,
.Xr round 3
.Sh STANDARDS
The
.Fn llround ,
.Fn llroundf ,
.Fn lround ,
and
.Fn lroundf
functions conform to
.St -isoC-99 .
.Sh HISTORY
These routines first appeared in
.Fx 5.4 .

View File

@ -32,7 +32,7 @@
.\" from: @(#)math.3 6.10 (Berkeley) 5/6/91
.\" $FreeBSD$
.\"
.Dd June 11, 2004
.Dd January 11, 2005
.Dt MATH 3
.Os
.if n \{\
@ -120,15 +120,15 @@ j1 bessel function ???
jn bessel function ???
ldexp multiply by power of 2 0
lgamma log gamma function 1
.\" llrint round to integer 0
.\" llround round to nearest integer 0
llrint round to integer 0
llround round to nearest integer 0
log natural logarithm 1
log10 logarithm to base 10 1
log1p log(1+x) 1
.\" log2 base 2 logarithm 0
logb exponent extraction 0
.\" lrint round to integer 0
.\" lround round to nearest integer 0
lrint round to integer 0
lround round to nearest integer 0
modf extract fractional part 0
.\" nan return quiet \*(Na) 0
nearbyint round to integer 0

View File

@ -77,6 +77,8 @@ an inexact exception.
.Xr fenv 3 ,
.Xr floor 3 ,
.Xr ieee 3 ,
.Xr lrint 3 ,
.Xr lround 3 ,
.Xr math 3 ,
.Xr round 3
.Sh STANDARDS

View File

@ -55,6 +55,8 @@ absolute value (i.e., they round away from zero).
.Xr ceil 3 ,
.Xr floor 3 ,
.Xr ieee 3 ,
.Xr lrint 3 ,
.Xr lround 3 ,
.Xr math 3 ,
.Xr rint 3 ,
.Xr trunc 3