Skip to content

Latest commit

 

History

History
129 lines (106 loc) · 4.23 KB

fmod.md

File metadata and controls

129 lines (106 loc) · 4.23 KB

fmod

  • cmath[meta header]
  • std[meta namespace]
  • function[meta id-type]
namespace std {
  float fmod(float x, float y);    // (1) C++03からC++20まで
  double fmod(double x, double y); // (2) C++03からC++20まで
  long double fmod(long double x,
                   long double y); // (3) C++03からC++20まで

  constexpr floating-point-type
    fmod(floating-point-type x,
         floating-point-type y);   // (4) C++23

  Integral
    fmod(Integral x, Integral y);  // (5) C++11
  constexpr Integral
    fmod(Integral x, Integral y);  // (5) C++23

  float
    fmodf(float x, float y);       // (6) C++17
  constexpr float
    fmodf(float x, float y);       // (6) C++23

  long double
    fmodl(long double x,
          long double y);          // (7) C++17
  constexpr long double
    fmodl(long double x,
          long double y);          // (8) C++17
}
  • Integral[italic]

概要

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

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

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

戻り値

x / yの余りを返す。

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

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

備考

  • 本関数は、C99 の規格にある fmod（より正確には math.h ヘッダの fmod、fmodf、fmodl の 3 つ。それぞれ C++ の double、float、long 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);
}
    • remainder[link remainder.md]
    • fabs[link fabs.md]
    • signbit[link signbit.md]
    • copysign[link copysign.md]

例

#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);
}
  • std::fmod[color ff0000]

出力例

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

参照