std::fmod, std::fmodf, std::fmodl

この関数によって計算される除算 x/y の浮動小数点の余りは、正確に値 x - n*y です。 ただし n は x/y の小数部を切り捨てたものです。

戻り値は x と同じ符号を持ち、 y より小さな絶対値を持ちます。

[編集] 引数

[編集] 戻り値

成功した場合、上で定義された通りの除算 x/y の浮動小数点の余りを返します。

定義域エラーが発生した場合、処理系定義の値 (サポートされていれば NaN) が返されます。

アンダーフローにより値域エラーが発生した場合、 (丸めた後の) 正しい結果が返されます。

[編集] エラー処理

math_errhandling で規定されている通りにエラーが報告されます。

y がゼロの場合、定義域エラーが発生する場合があります。

処理系が IEEE 浮動小数点算術 (IEC 60559) をサポートしている場合、

• x が ±0 であり y がゼロでなければ、 ±0 が返されます。
• x が ±∞ であり y が NaN でなければ、 NaN が返され、 FE_INVALID が発生します。
• y が ±0 であり x が NaN でなければ、 NaN が返され、 FE_INVALID が発生します。
• y が ±∞ であり x が有限であれば、 x が返されます。
• いずれかの引数が NaN であれば、 NaN が返されます。

[編集] ノート

POSIX は、 x が無限大または y がゼロの場合、定義域エラーが発生することを要求しています。

std::fmod は浮動小数点型の符号なし整数型へのサイレントなラッピングを行うのに便利です (しかし std::remainder はそうではありません)。 (0.0 <= (y = std::fmod( std::rint(x), 65536.0 )) ? y : 65536.0 + y) は unsigned short に対応する [-0.0 .. 65535.0] の範囲内になりますが、 std::remainder(std::rint(x), 65536.0) は signed short の範囲外である [-32767.0, +32768.0] の範囲内になります。

fmod の double 版は以下のように実装されているかのように動作します。

double fmod(double x, double y)
{
#pragma STDC FENV_ACCESS ON
    double result = std::remainder(std::fabs(x), (y = std::fabs(y)));
    if (std::signbit(result)) result += y;
    return std::copysign(result, x);
}

式 x - trunc(x/y)*y は、 trunc の引数を初期化するための x/y の丸めが精度を失いすぎると (例えば x = 30.508474576271183309, y = 6.1016949152542370172)、 fmod(x,y) と等しくなくなることがあります。

[編集] 例

#include <iostream>
#include <cmath>
#include <cfenv>
 
#pragma STDC FENV_ACCESS ON
int main()
{
    std::cout << "fmod(+5.1, +3.0) = " << std::fmod(5.1,3) << '\n'
              << "fmod(-5.1, +3.0) = " << std::fmod(-5.1,3) << '\n'
              << "fmod(+5.1, -3.0) = " << std::fmod(5.1,-3) << '\n'
              << "fmod(-5.1, -3.0) = " << std::fmod(-5.1,-3) << '\n';
 
    // 特殊な値
    std::cout << "fmod(+0.0, 1.0) = " << std::fmod(0, 1) << '\n'
              << "fmod(-0.0, 1.0) = " << std::fmod(-0.0, 1) << '\n'
              << "fmod(5.1, Inf) = " << std::fmod(5.1, INFINITY) << '\n';
 
    // エラー処理
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "fmod(+5.1, 0) = " << std::fmod(5.1, 0) << '\n';
    if(std::fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

fmod(+5.1, +3.0) = 2.1
fmod(-5.1, +3.0) = -2.1
fmod(+5.1, -3.0) = 2.1
fmod(-5.1, -3.0) = -2.1
fmod(+0.0, 1.0) = 0
fmod(-0.0, 1.0) = -0
fmod(5.1, Inf) = 5.1
fmod(+5.1, 0) = -nan
    FE_INVALID raised

[編集] 関連項目