4. lrint

最終更新日時(UTC):
が更新

履歴 編集

function
<cmath>

std::lrint(C++11)

namespace std {
  long lrint(float x);               // (1) C++11からC++20まで
  long lrint(double x);              // (2) C++11からC++20まで
  long lrint(long double x);         // (3) C++11からC++20まで

  long lrint(floating-point-type x); // (4) C++23

  long lrint(Integral x);            // (5) C++11

  long int lrintf(float x);          // (6) C++17
  long int lrintl(long double x);    // (7) C++17
}

概要

引数 x を現在の丸めモードで long に丸めた値を得る。

  • (1) : floatに対するオーバーロード
  • (2) : doubleに対するオーバーロード
  • (3) : long doubleに対するオーバーロード
  • (4) : 浮動小数点数型に対するオーバーロード
  • (5) : 整数型に対するオーバーロード (doubleにキャストして計算される)
  • (6) : float型規定
  • (7) : long double型規定

戻り値

引数 x を現在の丸めモードで long に丸めた値

備考

  • 本関数は、C99 の規格にある lrint（より正確には math.h ヘッダの lrint、lrintf、lrintl の 3 つ。それぞれ C++ の double、float、long double バージョンに相当）と等価である。
  • C++11 以降では、処理系が IEC 60559 に準拠している場合（std::numeric_limits<T>::is_iec559() != false）、以下の規定が追加される。
    • 丸めの結果が long で表現不可能な場合、無効演算の浮動小数点例外（FE_INVALID）が発生する。
    • 他の例外が発生しておらず、引数 x が戻り値と異なってる場合、不正確結果の浮動小数点例外（FE_INEXACT）が発生する。
  • C99 では、丸めモードや浮動小数点例外へのアクセスには #pragma STDC FENV_ACCESS ON でなければなければならないと記載されているが、C++ には該当する記載を見つけることができなかった。
    なお、C99 でも FENV_ACCESS のデフォルトは処理系定義である。
  • 丸めモード FE_TONEAREST は単なる四捨五入ではないことに注意。
    四捨五入が必要であれば、lround を使用すること。（ただし、lround は本関数と異なり、ISO IEC 60559 に準拠していても FE_INEXACT が発生するか否かは処理系定義である）
  • C++23では、(1)、(2)、(3)が(4)に統合され、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

例

#include <cfenv>
#include <climits>
#include <cmath>
#include <iostream>

void test(long double d)
{
  std::feclearexcept(FE_ALL_EXCEPT);
  long l = std::lrint(d);
  bool inexact = std::fetestexcept(FE_INEXACT) != 0;
  bool invalid = std::fetestexcept(FE_INVALID) != 0;
  std::cout << "lrint(" << d << ") = " << l << ", FE_INEXACT = " << std::boolalpha << inexact << ", FE_INVALID = " << invalid << '\n';
}

void test(const char* title, int round_mode)
{
  std::fesetround(round_mode);
  std::cout << title << '\n';
  test(4.0L);
  test(3.5L);
  test(2.5L);
  test(-2.5L);
  test(-3.5L);
  test(LONG_MAX + 0.5L);
  std::cout << '\n';
}

# define test(mode) test(#mode, mode)

int main()
{
# ifdef FE_DOWNWARD
  test(FE_DOWNWARD);
# endif
# ifdef FE_TONEAREST
  test(FE_TONEAREST);
# endif
# ifdef FE_TOWARDZERO
  test(FE_TOWARDZERO);
# endif
# ifdef FE_UPWARD
  test(FE_UPWARD);
# endif
}

出力例

FE_DOWNWARD
lrint(4) = 4, FE_INEXACT = false, FE_INVALID = false
lrint(3.5) = 3, FE_INEXACT = true, FE_INVALID = false
lrint(2.5) = 2, FE_INEXACT = true, FE_INVALID = false
lrint(-2.5) = -3, FE_INEXACT = true, FE_INVALID = false
lrint(-3.5) = -4, FE_INEXACT = true, FE_INVALID = false
lrint(9.22337e+18) = 9223372036854775807, FE_INEXACT = true, FE_INVALID = false

FE_TONEAREST
lrint(4) = 4, FE_INEXACT = false, FE_INVALID = false
lrint(3.5) = 4, FE_INEXACT = true, FE_INVALID = false
lrint(2.5) = 2, FE_INEXACT = true, FE_INVALID = false
lrint(-2.5) = -2, FE_INEXACT = true, FE_INVALID = false
lrint(-3.5) = -4, FE_INEXACT = true, FE_INVALID = false
lrint(9.22337e+18) = -9223372036854775808, FE_INEXACT = false, FE_INVALID = true

FE_TOWARDZERO
lrint(4) = 4, FE_INEXACT = false, FE_INVALID = false
lrint(3.5) = 3, FE_INEXACT = true, FE_INVALID = false
lrint(2.5) = 2, FE_INEXACT = true, FE_INVALID = false
lrint(-2.5) = -2, FE_INEXACT = true, FE_INVALID = false
lrint(-3.5) = -3, FE_INEXACT = true, FE_INVALID = false
lrint(9.22337e+18) = 9223372036854775807, FE_INEXACT = true, FE_INVALID = false

FE_UPWARD
lrint(4) = 4, FE_INEXACT = false, FE_INVALID = false
lrint(3.5) = 4, FE_INEXACT = true, FE_INVALID = false
lrint(2.5) = 3, FE_INEXACT = true, FE_INVALID = false
lrint(-2.5) = -2, FE_INEXACT = true, FE_INVALID = false
lrint(-3.5) = -3, FE_INEXACT = true, FE_INVALID = false
lrint(9.22337e+18) = -9223372036854775808, FE_INEXACT = false, FE_INVALID = true

上記出力例では、引数が整数値でないものは、FE_INEXACT が発生している。
また、引数が LONG_MAX + 0.5L のものは、丸めモードが FE_TONEAREST と FE_UPWARD の場合に FE_INVALID が発生している。（結果が long の範囲に収まらない）
丸めモードが FE_TONEAREST の場合、引数が 3.5 の時は 4 に切り上げられているのに対して、引数が 2.5 の時には 2 に切り捨てられていることに注意。
なお、処理系が ISO IEC 60559 に準拠していない場合、全ての丸めモードが利用可能とは限らない。
また、処理系が ISO IEC 60559 に準拠していない場合、FE_INEXACT や FE_INVALID は発生しない可能性がある。

バージョン

言語

  • C++11

処理系

  • Clang: 3.0 ✅, 3.1 ✅, 3.2 ✅, 3.3 ✅, 3.4 ✅, 3.5 ✅, 3.6 ✅, 3.7 ✅, 3.8 ✅
  • GCC: 4.3.6 ✅, 4.4.7 ✅, 4.5.4 ✅, 4.6.4 ✅, 4.7.3 ✅, 4.8.1 ✅, 4.8.2 ✅, 4.9.0 ✅, 4.9.1 ✅, 4.9.2 ✅, 5.1.0 ✅, 5.2.0 ✅, 6.0.0 ✅
  • ICC: ??
  • Visual C++: 2013 ✅, 2015 ✅

備考

  • 本関数は C++11 で追加されたが、Clang(libc++) では C++11 モードでなくても使用可能である

参照