std::floor, std::floorf, std::floorl

float       floor ( float num );
double      floor ( double num );
long double floor ( long double num );

constexpr /* floating-point-type */
            floor ( /* floating-point-type */ num );

float       floorf( float num );

long double floorl( long double num );

template< class Integer >
double      floor ( Integer num );

double

Parameters

Return value

If no errors occur, the largest integer value not greater than num, that is ⌊num⌋, is returned.

Return value

num

Error handling

Errors are reported as specified in math_errhandling.

If the implementation supports IEEE floating-point arithmetic (IEC 60559),

• The current rounding mode has no effect.
• If num is ±∞, it is returned, unmodified
• If num is ±0, it is returned, unmodified
• If num is NaN, NaN is returned

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 (including std::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 argument num of integer type, std::floor(num) has the same effect as std::floor(static_cast<double>(num)).

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';
}

floor(+2.7) = 2.000000
floor(-2.7) = -3.000000
floor(-0.0) = -0.000000
floor(-Inf) = -inf

See also