Common mathematical functions | |||||||||||||||||||||||||||||||
Mathematical special functions(C++17) | |||||||||||||||||||||||||||||||
Mathematical constants(C++20) | |||||||||||||||||||||||||||||||
Basic linear algebra algorithms(C++26) | |||||||||||||||||||||||||||||||
Data-parallel types (SIMD)(C++26) | |||||||||||||||||||||||||||||||
Floating-point environment(C++11) | |||||||||||||||||||||||||||||||
Complex numbers | |||||||||||||||||||||||||||||||
Numeric array (valarray ) | |||||||||||||||||||||||||||||||
Pseudo-random number generation | |||||||||||||||||||||||||||||||
Bit manipulation(C++20) | |||||||||||||||||||||||||||||||
Saturation arithmetic(C++26) | |||||||||||||||||||||||||||||||
Factor operations | |||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||
Interpolations | |||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||
Generic numeric operations | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
C-style checked integer arithmetic | |||||||||||||||||||||||||||||||
|
Nearest integer floating point operations | |||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
Floating point manipulation functions | |||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||
Classification and comparison | |||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
Types | |||||||||||||||||||||||||||||||||||||||||
Macro constants | |||||||||||||||||||||||||||||||||||||||||
|
|
Defined in header <cmath> | ||
Rounding to floating-point types | ||
(1) | ||
float rint(float num); double rint(double num); | (since C++11) (until C++23) | |
/* floating-point-type */ rint(/* floating-point-type */ num); | (since C++23) | |
float rintf(float num); | (2) | (since C++11) |
longdouble rintl(longdouble num); | (3) | (since C++11) |
Rounding tolong | ||
(4) | ||
long lrint(float num); long lrint(double num); | (since C++11) (until C++23) | |
long lrint(/* floating-point-type */ num); | (since C++23) | |
long lrintf(float num); | (5) | (since C++11) |
long lrintl(longdouble num); | (6) | (since C++11) |
Rounding tolonglong | ||
(7) | ||
longlong llrint(float num); longlong llrint(double num); | (since C++11) (until C++23) | |
longlong llrint(/* floating-point-type */ num); | (since C++23) | |
longlong llrintf(float num); | (8) | (since C++11) |
longlong llrintl(longdouble num); | (9) | (since C++11) |
Defined in header <cmath> | ||
template<class Integer> double rint( Integer num); | (A) | (since C++11) |
template<class Integer> long lrint( Integer num); | (B) | (since C++11) |
template<class Integer> longlong llrint( Integer num); | (C) | (since C++11) |
std::rint
for all cv-unqualified floating-point types as the type of the parameternum.(since C++23)std::lrint
andstd::llrint
for all cv-unqualified floating-point types as the type of the parameternum.(since C++23)Contents |
num | - | floating-point or integer value |
If no errors occur, the nearest integer value tonum, according to thecurrent rounding mode, is returned.
Errors are reported as specified inmath_errhandling.
If the result ofstd::lrint
orstd::llrint
is outside the range representable by the return type, a domain error or a range error may occur.
If the implementation supports IEEE floating-point arithmetic (IEC 60559),
std::rint
function:std::lrint
andstd::llrint
functions:POSIX specifies that all cases wherestd::lrint
orstd::llrint
raiseFE_INEXACT are domain errors.
As specified inmath_errhandling,FE_INEXACT may be (but isn't required to be on non-IEEE floating-point platforms) raised bystd::rint
when rounding a non-integer finite value.
The only difference betweenstd::rint
andstd::nearbyint is thatstd::nearbyint never raisesFE_INEXACT.
The largest representable floating-point values are exact integers in all standard floating-point formats, sostd::rint
never overflows on its own; however the result may overflow any integer type (includingstd::intmax_t), when stored in an integer variable.
If the current rounding mode is:
std::rint
is equivalent tostd::floor.std::rint
is equivalent tostd::ceil.std::rint
is equivalent tostd::trunc.std::rint
differs fromstd::round in that halfway cases are rounded to even rather than away from zero.The additional overloads are not required to be provided exactly as(A-C). They only need to be sufficient to ensure that for their argumentnum of integer type:
#include <cfenv>#include <climits>#include <cmath>#include <iostream>// #pragma STDC FENV_ACCESS ON int main(){std::fesetround(FE_TONEAREST);std::cout<<"Rounding to nearest (halfway cases to even):\n"<<" rint(+2.3) = "<< std::rint(2.3)<<'\n'<<" rint(+2.5) = "<< std::rint(2.5)<<'\n'<<" rint(+3.5) = "<< std::rint(3.5)<<'\n'<<" rint(-2.3) = "<< std::rint(-2.3)<<'\n'<<" rint(-2.5) = "<< std::rint(-2.5)<<'\n'<<" rint(-3.5) = "<< std::rint(-3.5)<<'\n'; std::fesetround(FE_DOWNWARD);std::cout<<"Rounding down:\n"<<" rint(+2.3) = "<< std::rint(2.3)<<'\n'<<" rint(+2.5) = "<< std::rint(2.5)<<'\n'<<" rint(+3.5) = "<< std::rint(3.5)<<'\n'<<" rint(-2.3) = "<< std::rint(-2.3)<<'\n'<<" rint(-2.5) = "<< std::rint(-2.5)<<'\n'<<" rint(-3.5) = "<< std::rint(-3.5)<<'\n'<<"Rounding down with lrint:\n"<<" lrint(+2.3) = "<< std::lrint(2.3)<<'\n'<<" lrint(+2.5) = "<< std::lrint(2.5)<<'\n'<<" lrint(+3.5) = "<< std::lrint(3.5)<<'\n'<<" lrint(-2.3) = "<< std::lrint(-2.3)<<'\n'<<" lrint(-2.5) = "<< std::lrint(-2.5)<<'\n'<<" lrint(-3.5) = "<< std::lrint(-3.5)<<'\n'<<"Special values:\n"<<" lrint(-0.0) = "<< std::lrint(-0.0)<<'\n'<<std::hex<<std::showbase<<" lrint(-Inf) = "<< std::lrint(-INFINITY)<<'\n'; // error handlingstd::feclearexcept(FE_ALL_EXCEPT); std::cout<<"std::rint(0.1) = "<< std::rint(.1)<<'\n';if(std::fetestexcept(FE_INEXACT))std::cout<<" FE_INEXACT was raised\n"; std::feclearexcept(FE_ALL_EXCEPT); std::cout<<"std::lrint(LONG_MIN-2048.0) = "<< std::lrint(LONG_MIN-2048.0)<<'\n';if(std::fetestexcept(FE_INVALID))std::cout<<" FE_INVALID was raised\n";}
Possible output:
Rounding to nearest (halfway cases to even): rint(+2.3) = 2 rint(+2.5) = 2 rint(+3.5) = 4 rint(-2.3) = -2 rint(-2.5) = -2 rint(-3.5) = -4Rounding down: rint(+2.3) = 2 rint(+2.5) = 2 rint(+3.5) = 4 rint(-2.3) = -2 rint(-2.5) = -2 rint(-3.5) = -4Rounding down with lrint: lrint(+2.3) = 2 lrint(+2.5) = 2 lrint(+3.5) = 3 lrint(-2.3) = -3 lrint(-2.5) = -3 lrint(-3.5) = -4Special values: lrint(-0.0) = 0 lrint(-Inf) = 0x8000000000000000std::rint(0.1) = 0std::lrint(LONG_MIN-2048.0) = 0x8000000000000000 FE_INVALID was raised
(C++11)(C++11)(C++11) | nearest integer not greater in magnitude than the given value (function)[edit] |
(C++11)(C++11)(C++11) | nearest integer using current rounding mode (function)[edit] |
(C++11)(C++11) | gets or sets rounding direction (function)[edit] |
C documentation forrint |