std::remainder, std::remainderf, std::remainderl

この関数によって計算される除算 x/y の IEEE 浮動小数点剰余は、正確に値 x - n*y です。 ただし値 n は正確な値 x - n*y に最も近い整数値です。 |n-x/y| = ½ のとき、値 n は偶数になるように選ばれます。

std::fmod() と対照的に、戻り値が x と同じ符号を持つことは保証されません。

戻り値が 0 の場合、 x と同じ符号を持ちます。

[編集] 引数

[編集] 戻り値

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

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

アンダーフローによって値域エラーが発生した場合、正しい結果が返されます。

y がゼロだけれども定義域エラーが発生しない場合、ゼロが返されます。

[編集] エラー処理

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

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

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

• 現在の丸めモードは効果を持ちません。
• FE_INEXACT が発生することはありません。 結果は常に正確です。
• x が ±∞ であり y が NaN でなければ、 NaN が返され、 FE_INVALID が発生します。
• y が ±0 であり x が NaN でなければ、 NaN が返され、 FE_INVALID が発生します。
• いずれかの引数が 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] の範囲内になります。

[編集] 例

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

remainder(+5.1, +3.0) = -0.9
remainder(-5.1, +3.0) = 0.9
remainder(+5.1, -3.0) = -0.9
remainder(-5.1, -3.0) = 0.9
remainder(-0.0, 1.0) = -0
remainder(5.1, Inf) = 5.1
remainder(+5.1, 0) = -nan
    FE_INVALID raised

[編集] 関連項目