1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
'\" et
.TH RINT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
rint,
rintf,
rintl
\(em round-to-nearest integral value
.SH SYNOPSIS
.LP
.nf
#include <math.h>
.P
double rint(double \fIx\fP);
float rintf(float \fIx\fP);
long double rintl(long double \fIx\fP);
.fi
.SH DESCRIPTION
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
These functions shall return the integral value (represented as a
.BR double )
nearest
.IR x
in the direction of the current rounding mode. The current rounding
mode is implementation-defined.
.P
If the current rounding mode rounds toward negative infinity, then
\fIrint\fR()
shall be equivalent to
.IR "\fIfloor\fR\^(\|)".
If the current rounding mode rounds toward positive infinity, then
\fIrint\fR()
shall be equivalent to
.IR "\fIceil\fR\^(\|)".
If the current rounding mode rounds towards zero, then
\fIrint\fR()
shall be equivalent to
.IR "\fItrunc\fR\^(\|)".
If the current rounding mode rounds towards nearest, then
\fIrint\fR()
differs from
.IR "\fIround\fR\^(\|)"
in that halfway cases are rounded to even rather than away from zero.
.P
These functions differ from the
\fInearbyint\fR(),
\fInearbyintf\fR(),
and
\fInearbyintl\fR()
functions only in that they may raise the inexact floating-point
exception if the result differs in value from the argument.
.P
An application wishing to check for error situations should set
.IR errno
to zero and call
.IR feclearexcept (FE_ALL_EXCEPT)
before calling these functions. On return, if
.IR errno
is non-zero or \fIfetestexcept\fR(FE_INVALID | FE_DIVBYZERO |
FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.
.SH "RETURN VALUE"
Upon successful completion, these functions shall return the integer
(represented as a double precision number) nearest
.IR x
in the direction of the current rounding mode.
The result shall have the same sign as
.IR x .
.P
If
.IR x
is NaN, a NaN shall be returned.
.P
If
.IR x
is \(+-0 or \(+-Inf,
.IR x
shall be returned.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
The integral value returned by these functions need not be expressible
as an
.BR intmax_t .
The return value should be tested before assigning it to an integer type
to avoid the undefined results of an integer overflow.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIabs\fR\^(\|)",
.IR "\fIceil\fR\^(\|)",
.IR "\fIfeclearexcept\fR\^(\|)",
.IR "\fIfetestexcept\fR\^(\|)",
.IR "\fIfloor\fR\^(\|)",
.IR "\fIisnan\fR\^(\|)",
.IR "\fInearbyint\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "Section 4.20" ", " "Treatment of Error Conditions for Mathematical Functions",
.IR "\fB<math.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|
