std:: remquo, std:: remquof, std:: remquol

パラメータ

戻り値

成功した場合、x/yの除算の浮動小数点剰余を std::remainder で定義されている通りに返し、 *quo に x/y の符号と少なくとも下位3ビットの情報を格納する （形式的には、 x/y の符号と同じ符号を持ち、その大きさが 2n
を法として x/y の整数商の大きさと合同な値を格納する。ここで n は3以上の実装定義の整数である）。

y がゼロの場合、 * quo に格納される値は未定義です。

定義域エラーが発生した場合、実装定義の値が返されます（NaNがサポートされている場合はNaN）。

アンダーフローによる範囲エラーが発生した場合、サブノーマルがサポートされている場合は正しい結果が返されます。

y がゼロであるが、定義域エラーが発生しない場合、ゼロが返されます。

エラーハンドリング

エラーは math_errhandling で指定された通りに報告されます。

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

IEEE浮動小数点演算（IEC 60559）を実装がサポートしている場合、

• 現在の 丸めモード は効果を持ちません。
• FE_INEXACT は決して発生しません。
• x が±∞で、 y がNaNでない場合、NaNが返され、 FE_INVALID が発生します。
• y が±0で、 x がNaNでない場合、NaNが返され、 FE_INVALID が発生します。
• x または y のいずれかがNaNの場合、NaNが返されます。

注記

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

この関数は、周期が浮動小数点値として正確に表現可能な周期関数を実装する際に有用です：非常に大きな x に対して sin(πx) を計算する場合、 std::sin を直接呼び出すと大きな誤差が生じる可能性がありますが、関数引数を最初に std::remquo で還元すると、商の下位ビットを使用して周期内の結果の符号とオクタントを決定できる一方、剰余を使用して高精度で値を計算できます。

一部のプラットフォームでは、この演算はハードウェアでサポートされています（例えば、Intel CPUでは、 FPREM1 は完了時に商の精度を正確に3ビット残します）。

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

例

#include <cfenv>
#include <cmath>
#include <iostream>
#ifndef __GNUC__
#pragma STDC FENV_ACCESS ON
#endif
const double pi = std::acos(-1); // または C++20 以降では std::numbers::pi
double cos_pi_x_naive(double x)
{
    return std::cos(pi * x);
}
// 周期は2、(0;0.5)で正、(0.5;1.5)で負、(1.5,2)で正の値を取る
double cos_pi_x_smart(double x)
{
    int quadrant;
    double rem = std::remquo(x, 1, &quadrant);
    quadrant = static_cast<unsigned>(quadrant) % 2; // 周期は2
    return quadrant == 0 ?  std::cos(pi * rem)
                         : -std::cos(pi * rem);
}
int main()
{
    std::cout << std::showpos
              << "naive:\n"
              << "  cos(pi * 0.25) = " << cos_pi_x_naive(0.25) << '\n'
              << "  cos(pi * 1.25) = " << cos_pi_x_naive(1.25) << '\n'
              << "  cos(pi * 2.25) = " << cos_pi_x_naive(2.25) << '\n'
              << "smart:\n"
              << "  cos(pi * 0.25) = " << cos_pi_x_smart(0.25) << '\n'
              << "  cos(pi * 1.25) = " << cos_pi_x_smart(1.25) << '\n'
              << "  cos(pi * 2.25) = " << cos_pi_x_smart(2.25) << '\n'
              << "naive:\n"
              << "  cos(pi * 1000000000000.25) = "
              << cos_pi_x_naive(1000000000000.25) << '\n'
              << "  cos(pi * 1000000000001.25) = "
              << cos_pi_x_naive(1000000000001.25) << '\n'
              << "smart:\n"
              << "  cos(pi * 1000000000000.25) = "
              << cos_pi_x_smart(1000000000000.25) << '\n'
              << "  cos(pi * 1000000000001.25) = "
              << cos_pi_x_smart(1000000000001.25) << '\n';
    // エラー処理
    std::feclearexcept(FE_ALL_EXCEPT);
    int quo;
    std::cout << "remquo(+Inf, 1) = " << std::remquo(INFINITY, 1, &quo) << '\n';
    if (fetestexcept(FE_INVALID))
        std::cout << "  FE_INVALID が発生\n";
}

naive:
  cos(pi * 0.25) = +0.707107
  cos(pi * 1.25) = -0.707107
  cos(pi * 2.25) = +0.707107
smart:
  cos(pi * 0.25) = +0.707107
  cos(pi * 1.25) = -0.707107
  cos(pi * 2.25) = +0.707107
naive:
  cos(pi * 1000000000000.25) = +0.707123
  cos(pi * 1000000000001.25) = -0.707117
smart:
  cos(pi * 1000000000000.25) = +0.707107
  cos(pi * 1000000000001.25) = -0.707107
remquo(+Inf, 1) = -nan
  FE_INVALID raised

関連項目