最終更新日時(UTC): 2025年08月23日 16時55分29秒
Raclamusi が更新

履歴 編集

function
<cmath>

# std::rint(C++11)

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

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

      double rint(Integral x);          // (5) C++11

      float rintf(float x);             // (6) C++17
      long double rintl(long double x); // (7) C++17
    }

## 概要

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

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

## 戻り値

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

## 備考

- 本関数と `nearbyint` は戻り値は同一であるが、本関数は引数 `x` が戻り値と異なってる場合 `FE_INEXACT` が発生する可能性があるが、`nearbyint` は発生しない点のみ動作が異なる。
- 本関数は、C99 の規格にある `rint`（より正確には `math.h` ヘッダの `rint`、`rintf`、`rintl` の 3 つ。それぞれ C++ の `double`、`float`、`long double` バージョンに相当）と等価である。
- C++11 以降では、処理系が IEC 60559 に準拠している場合（`std::numeric_limits<T>::is_iec559() != false`）、以下の規定が追加される。
  - `x = ±0` の場合、`±0` を返す。
  - `x = ±∞` の場合、`±∞` を返す。
  - 引数 `x` が戻り値と異なってる場合、`FE_INEXACT` が発生する。
- C99 では、丸めモードの設定時には `#pragma STDC FENV_ACCESS ON` でなければならないと記載されているが、C++ には該当する記載を見つけることができなかった。
  なお、C99 でも `FENV_ACCESS` のデフォルトは処理系定義である。
- 丸めモード `FE_TONEAREST` は単なる四捨五入ではないことに注意。
- C++23では、(1), (2), (3)が(4)に統合され、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

## 例

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

    void test(const char* title, int round_mode)
    {
      std::feclearexcept(FE_ALL_EXCEPT);
      std::fesetround(round_mode);
      std::cout << title << std::endl;
      std::cout << "rint(2.5) = " << std::rint(2.5) << std::endl;
      std::cout << "rint(-2.5) = " << std::rint(-2.5) << std::endl;
      std::cout << "FE_INEXACT = " << std::boolalpha << (std::fetestexcept(FE_INEXACT) != 0) << std::endl << std::endl;
    }

    #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
    rint(2.5) = 2
    rint(-2.5) = -3
    FE_INEXACT = true

    FE_TONEAREST
    rint(2.5) = 2
    rint(-2.5) = -2
    FE_INEXACT = true

    FE_TOWARDZERO
    rint(2.5) = 2
    rint(-2.5) = -2
    FE_INEXACT = true

    FE_UPWARD
    rint(2.5) = 3
    rint(-2.5) = -2
    FE_INEXACT = true

処理系が ISO IEC 60559 に準拠していない場合、全ての丸めモードが利用可能とは限らない。
また、処理系が IEC60559 に準拠していない場合、`FE_INEXACT` は `false` の可能性がある。

## バージョン

### 言語

- C++11

### 処理系

- Clang: 3.0 ✅, 3.1 ✅, 3.2 ✅, 3.3 ✅, 3.4 ✅, 3.5 ✅, 3.6 ✅, 3.7 ✅
- 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 ✅, 5.0.0 ✅
- ICC: ??
- Visual C++: 2013 ✅, 2015 ✅

### 備考

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

## 関連項目

- 戻り値 `long` 版 `lrint`
- 戻り値 `long long` 版 `llrint`
- `FE_INEXACT` が発生しない版 `nearbyint`
- 常に四捨五入: `round`、`lround` (戻り値 `long`)、`llround` (戻り値 `long long`)
- 丸めモード: `fesetround` (設定)、`fegetround` (取得)、`FLT_ROUNDS` (マクロ)

## 参照

- P1467R9 Extended floating-point types and standard names
  - C++23で導入された拡張浮動小数点数型への対応として、`float`、`double`、`long double`のオーバーロードを`floating-point-type`のオーバーロードに統合し、拡張浮動小数点数型も扱えるようにした