namespace std {
float floor(float x);
double floor(double x);
long double floor(long double x);
double floor(Integral x); // C++11 から
float floorf(float x); // C++17 から
long double floorl(long double x); // C++17 から
}
概要
引数 x
以下で最大の整数値を得る。(床関数)
戻り値
引数 x
以下で最大の整数値
備考
- 本関数は、C99 の規格にある
floor
(より正確にはmath.h
ヘッダのfloor
、floorf
、floorl
の 3 つ。それぞれ C++ のdouble
、float
、long double
バージョンに相当)と等価である。 -
C++11 以降では、処理系が IEC 60559 に準拠している場合(
std::numeric_limits<T>::is_iec559() != false
)、以下の規定が追加される。x = ±0
の場合、±0
を返す。x = ±∞
の場合、±∞
を返す。
また、本関数の挙動は、丸めモードが
FE_DOWNWARD
に設定されている時のrint
、あるいはnearbyint
のいずれかと等価である。
したがって、本関数において戻り値が引数x
と異なる場合に例外FE_INEXACT
が発生するか否かは実装依存である。
なお、本関数の挙動は、現在の丸めモードには依存しない。
例
#include <cfenv>
#include <cmath>
#include <iostream>
void test(double x)
{
std::feclearexcept(FE_ALL_EXCEPT);
std::cout << "floor(" << x << ") = " << std::floor(x) << '\n';
std::cout << "FE_INEXACT = " << std::boolalpha << (std::fetestexcept(FE_INEXACT) != 0) << "\n\n";
}
int main()
{
test(2.0);
test(2.1);
test(2.5);
test(2.9);
test(-2.0);
test(-2.1);
test(-2.5);
test(-2.9);
}
出力例
floor(2) = 2
FE_INEXACT = false
floor(2.1) = 2
FE_INEXACT = true
floor(2.5) = 2
FE_INEXACT = true
floor(2.9) = 2
FE_INEXACT = true
floor(-2) = -2
FE_INEXACT = false
floor(-2.1) = -3
FE_INEXACT = true
floor(-2.5) = -3
FE_INEXACT = true
floor(-2.9) = -3
FE_INEXACT = true
引数と結果が異なる場合に例外 FE_INEXACT
が発生するか否かは実装によって異なる。