]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/lrint.3
dlopen.3: Clarify that constructors are called only when library is first loaded
[thirdparty/man-pages.git] / man3 / lrint.3
index c81a64a59538ef8693e8a38bd62dc460fabbe264..cee7d73b7f62e4e93d041dba1defb27b69b74c9d 100644 (file)
@@ -1,5 +1,8 @@
 .\" Copyright 2001 Andries Brouwer <aeb@cwi.nl>.
+.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
+.\"     <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
-.TH LRINT 3  2007-07-26 "" "Linux Programmer's Manual"
+.TH LRINT 3  2017-09-15 "" "Linux Programmer's Manual"
 .SH NAME
 lrint, lrintf, lrintl, llrint, llrintf, llrintl \- round to nearest integer
 .SH SYNOPSIS
 .nf
 .B #include <math.h>
-.sp
+.PP
 .BI "long int lrint(double " x );
-.br
 .BI "long int lrintf(float " x );
-.br
 .BI "long int lrintl(long double " x );
-.sp
+.PP
 .BI "long long int llrint(double " x );
-.br
 .BI "long long int llrintf(float " x );
-.br
 .BI "long long int llrintl(long double " x );
 .fi
-.sp
+.PP
 Link with \fI\-lm\fP.
-.sp
+.PP
 .in -4n
 Feature Test Macro Requirements for glibc (see
 .BR feature_test_macros (7)):
 .in
-.sp
+.PP
 .ad l
 All functions shown above:
-_XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
-.I cc\ -std=c99
-.ad b
+.RS 4
+_ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L
+.RE
+.ad
 .SH DESCRIPTION
 These functions round their argument to the nearest integer value,
-using the current rounding direction.
-If \fIx\fP is infinite or NaN, or if the rounded value is outside
-the range of the return type, the numeric result is unspecified.
-A domain error may occur if the magnitude of \fIx\fP is too large.
-.SH "RETURN VALUE"
-The rounded integer value.
+using the current rounding direction (see
+.BR fesetround (3)).
+.PP
+Note that unlike the
+.BR rint (3)
+family of functions,
+the return type of these functions differs from
+that of their arguments.
+.SH RETURN VALUE
+These functions return the rounded integer value.
+.PP
+If
+.I x
+is a NaN or an infinity,
+or the rounded value is too large to be stored in a
+.I long
+.RI ( "long long"
+in the case of the
+.B ll*
+functions),
+then a domain error occurs, and the return value is unspecified.
+.\" The return value is -(LONG_MAX - 1) or -(LLONG_MAX -1)
 .SH ERRORS
+See
+.BR math_error (7)
+for information on how to determine whether an error has occurred
+when calling these functions.
+.PP
+The following errors can occur:
 .TP
-.B EDOM
-The magnitude of \fIx\fP is too large and
-.I "(math_errhandling & MATH_ERRNO)"
-is nonzero.
-.SH "CONFORMING TO"
-C99.
-.SH "SEE ALSO"
+Domain error: \fIx\fP is a NaN or infinite, or the rounded value is too large
+.\" .I errno
+.\" is set to
+.\" .BR EDOM .
+An invalid floating-point exception
+.RB ( FE_INVALID )
+is raised.
+.PP
+These functions do not set
+.IR errno .
+.\" FIXME . Is it intentional that these functions do not set errno?
+.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6798
+.SH VERSIONS
+These functions first appeared in glibc in version 2.1.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbw30 lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR lrint (),
+.BR lrintf (),
+.BR lrintl (),
+.br
+.BR llrint (),
+.BR llrintf (),
+.BR llrintl ()
+T}     Thread safety   MT-Safe
+.TE
+.SH CONFORMING TO
+C99, POSIX.1-2001, POSIX.1-2008.
+.SH SEE ALSO
 .BR ceil (3),
 .BR floor (3),
 .BR lround (3),