Blame man3/lrint.3

Packit 7cfc04
.\" Copyright 2001 Andries Brouwer <aeb@cwi.nl>.
Packit 7cfc04
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
Packit 7cfc04
.\"     <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH LRINT 3  2017-09-15 "" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
lrint, lrintf, lrintl, llrint, llrintf, llrintl \- round to nearest integer
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <math.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "long int lrint(double " x );
Packit 7cfc04
.BI "long int lrintf(float " x );
Packit 7cfc04
.BI "long int lrintl(long double " x );
Packit 7cfc04
.PP
Packit 7cfc04
.BI "long long int llrint(double " x );
Packit 7cfc04
.BI "long long int llrintf(float " x );
Packit 7cfc04
.BI "long long int llrintl(long double " x );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
Link with \fI\-lm\fP.
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.ad l
Packit 7cfc04
All functions shown above:
Packit 7cfc04
.RS 4
Packit 7cfc04
_ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L
Packit 7cfc04
.RE
Packit 7cfc04
.ad
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
These functions round their argument to the nearest integer value,
Packit 7cfc04
using the current rounding direction (see
Packit 7cfc04
.BR fesetround (3)).
Packit 7cfc04
.PP
Packit 7cfc04
Note that unlike the
Packit 7cfc04
.BR rint (3)
Packit 7cfc04
family of functions,
Packit 7cfc04
the return type of these functions differs from
Packit 7cfc04
that of their arguments.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
These functions return the rounded integer value.
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is a NaN or an infinity,
Packit 7cfc04
or the rounded value is too large to be stored in a
Packit 7cfc04
.I long
Packit 7cfc04
.RI ( "long long"
Packit 7cfc04
in the case of the
Packit 7cfc04
.B ll*
Packit 7cfc04
functions),
Packit 7cfc04
then a domain error occurs, and the return value is unspecified.
Packit 7cfc04
.\" The return value is -(LONG_MAX - 1) or -(LLONG_MAX -1)
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
See
Packit 7cfc04
.BR math_error (7)
Packit 7cfc04
for information on how to determine whether an error has occurred
Packit 7cfc04
when calling these functions.
Packit 7cfc04
.PP
Packit 7cfc04
The following errors can occur:
Packit 7cfc04
.TP
Packit 7cfc04
Domain error: \fIx\fP is a NaN or infinite, or the rounded value is too large
Packit 7cfc04
.\" .I errno
Packit 7cfc04
.\" is set to
Packit 7cfc04
.\" .BR EDOM .
Packit 7cfc04
An invalid floating-point exception
Packit 7cfc04
.RB ( FE_INVALID )
Packit 7cfc04
is raised.
Packit 7cfc04
.PP
Packit 7cfc04
These functions do not set
Packit 7cfc04
.IR errno .
Packit 7cfc04
.\" FIXME . Is it intentional that these functions do not set errno?
Packit 7cfc04
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6798
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
These functions first appeared in glibc in version 2.1.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw30 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR lrint (),
Packit 7cfc04
.BR lrintf (),
Packit 7cfc04
.BR lrintl (),
Packit 7cfc04
.br
Packit 7cfc04
.BR llrint (),
Packit 7cfc04
.BR llrintf (),
Packit 7cfc04
.BR llrintl ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
C99, POSIX.1-2001, POSIX.1-2008.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR ceil (3),
Packit 7cfc04
.BR floor (3),
Packit 7cfc04
.BR lround (3),
Packit 7cfc04
.BR nearbyint (3),
Packit 7cfc04
.BR rint (3),
Packit 7cfc04
.BR round (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.