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

履歴 編集

function
<cmath>

std::fmod

namespace std {
  double fmod(double x, double y);
  float fmod(float x, float y);
  long double fmod(long double x, long double y);

  Integral fmod(Integral x, Integral y);           // C++11 から

  float fmodf(float x, float y);                   // C++17 から
  long double fmodl(long double x, long double y); // C++17 から
}

概要

浮動小数点数の剰余を求める。

整数に対する剰余は%演算子で求められるが、浮動小数点数に対しては本関数を使用する必要がある。

戻り値

x / yの余りを返す。

  • この関数は、ある整数値をnとして、x - nyを戻り値として返す。
  • yが非ゼロである場合、xと同じ符号の、yより小さい値を返す。
  • yがゼロである場合、定義域エラーを発生させるかゼロを返すかは、実装定義となる。

定義域エラーが発生した際の挙動については、<cmath> を参照。

備考

  • 本関数は、C99 の規格にある fmod(より正確には math.h ヘッダの fmodfmodffmodl の 3 つ。それぞれ C++ の doublefloatlong double バージョンに相当)と同等である。
  • C++11 以降では、処理系が IEC 60559 に準拠している場合(std::numeric_limits<T>::is_iec559() != false)、以下の規定が追加される。

    • 非ゼロのyについて、x±0の場合、±0を返す。
    • xが無限大、もしくはyがゼロである場合、NaNを返し、FE_INVALID が発生する。
    • xが非無限大で、y±∞の場合、xを返す。

    また、double バージョンの本関数は、以下の実装のように振る舞う。

    #include <math.h>
    #include <fenv.h>
    #pragma STDC FENV_ACCESS ON
    double fmod(double x, double y)
    {
      double result;
      result = remainder(fabs(x), (y = fabs(y)));
      if (signbit(result)) result += y;
      return copysign(result, x);
    }
    

#include <iostream>
#include <cmath>

void test(double x, double y)
{
  std::cout << "fmod(" << x << ", " << y << ") = " << std::fmod(x, y) << std::endl;
}

int main()
{
  test(5.0, 2.0);
  test(6.0, 4.0);
  test(6.3, 3.0);
  test(6.3, -3.0);
  test(-6.3, 3.0);
  test(-6.3, -3.0);
  test(6.3, 3.15);
  test(6.0, 2.0);
}

出力例

fmod(5, 2) = 1
fmod(6, 4) = 2
fmod(6.3, 3) = 0.3
fmod(6.3, -3) = 0.3
fmod(-6.3, 3) = -0.3
fmod(-6.3, -3) = -0.3
fmod(6.3, 3.15) = 0
fmod(6, 2) = 0