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

この関数によって計算される除算操作 x / y のIEEE浮動小数点剰余は、厳密に値 x - quo * y であり、ここで値 quo は厳密な値 x / y に最も近い整数値である。 |quo - x / y| = ½ の場合、値 quo は偶数となるように選択される。

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

返される値がゼロの場合、それは x と同じ符号を持ちます。

パラメータ

戻り値

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

定義域エラーが発生した場合、実装定義の値が返されます（NaNがサポートされている場合は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 は範囲 [ - 0.0 , 65535.0 ] 内に収まり、これは unsigned short に対応します。しかし std :: remainder ( std:: rint ( x ) , 65536.0 ) は範囲 [ - 32767.0 , + 32768.0 ] 内に収まり、これは signed short の範囲外です。

追加のオーバーロードは (A) と完全に同一である必要はありません。それらは、第一引数 num1 と第二引数 num2 について以下を保証するのに十分であればよいのです：

例

#include <cfenv>
#include <cmath>
#include <iostream>
// #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';
    // special values
    std::cout << "remainder(-0.0, 1.0) = " << std::remainder(-0.0, 1) << '\n'
              << "remainder(5.1, Inf) = " << std::remainder(5.1, INFINITY) << '\n';
    // error handling
    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

関連項目