std::floor,std::floorf,std::floorl
| 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> | ||
| (1) | ||
float floor(float num); double floor(double num); | (until C++23) | |
constexpr/*floating-point-type*/ floor(/*floating-point-type*/ num); | (since C++23) | |
float floorf(float num); | (2) | (since C++11) (constexpr since C++23) |
longdouble floorl(longdouble num); | (3) | (since C++11) (constexpr since C++23) |
SIMD overload(since C++26) | ||
Defined in header <simd> | ||
template</*math-floating-point*/ V> constexpr/*deduced-simd-t*/<V> | (S) | (since C++26) |
Additional overloads(since C++11) | ||
Defined in header <cmath> | ||
template<class Integer> double floor( Integer num); | (A) | (constexpr since C++23) |
std::floor for all cv-unqualified floating-point types as the type of the parameter.(since C++23)S) The SIMD overload performs an element-wise std::floor onv_num.
| (since C++26) |
A) Additional overloads are provided for all integer types, which are treated asdouble. | (since C++11) |
Contents |
[edit]Parameters
| num | - | floating-point or integer value |
[edit]Return value
If no errors occur, the largest integer value not greater thannum, that is⌊num⌋, is returned.
[edit]Error handling
Errors are reported as specified inmath_errhandling.
If the implementation supports IEEE floating-point arithmetic (IEC 60559),
- The currentrounding mode has no effect.
- Ifnum is ±∞, it is returned, unmodified.
- Ifnum is ±0, it is returned, unmodified.
- Ifnum is NaN, NaN is returned.
[edit]Notes
FE_INEXACT may be (but isn't required to be) raised when rounding a non-integer finite value.
The largest representable floating-point values are exact integers in all standard floating-point formats, so this function never overflows on its own; however the result may overflow any integer type (includingstd::intmax_t), when stored in an integer variable.
The additional overloads are not required to be provided exactly as(A). They only need to be sufficient to ensure that for their argumentnum of integer type,std::floor(num) has the same effect asstd::floor(static_cast<double>(num)).
[edit]Example
#include <cmath>#include <iostream> int main(){std::cout<<std::fixed<<"floor(+2.7) = "<< std::floor(+2.7)<<'\n'<<"floor(-2.7) = "<< std::floor(-2.7)<<'\n'<<"floor(-0.0) = "<< std::floor(-0.0)<<'\n'<<"floor(-Inf) = "<< std::floor(-INFINITY)<<'\n';}
Output:
floor(+2.7) = 2.000000floor(-2.7) = -3.000000floor(-0.0) = -0.000000floor(-Inf) = -inf
[edit]See also
(C++11)(C++11) | nearest integer not less than the given value (function)[edit] |
(C++11)(C++11)(C++11) | nearest integer not greater in magnitude than the given value (function)[edit] |
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)(C++11) | nearest integer, rounding away from zero in halfway cases (function)[edit] |
C documentation forfloor | |
