remquo, remquof, remquol

ヘッダ `<math.h>` で定義
`float remquof( float x, float y, int *quo );`	(1)	(C99以上)
`double remquo( double x, double y, int *quo );`	(2)	(C99以上)
`long double remquol( long double x, long double y, int *quo );`	(3)	(C99以上)
ヘッダ `<tgmath.h>` で定義
`#define remquo( x, y, quo )`	(4)	(C99以上)

1-3) remainder() 関数が行うように除算 x/y の浮動小数点剰余を計算します。さらに、周期内の結果の象限を判定するのに十分な、 x/y の少なくとも3個の最後のビットと符号が quo に格納されます。

4) 型総称マクロ。いずれかの非ポインタ引数が long double の場合は remquol が呼ばれます。そうでなく、いずれかの非ポインタ引数が整数型または double 型の場合は remquo が呼ばれます。そうでなければ remquof が呼ばれます。

成功した場合、 remainder で定義されている通りの除算 x/y の浮動小数点剰余を返し、 x/y の符号と少なくとも3個の最下位ビットを *quo に格納します (形式的には、符号が x/y の符号で、絶対値が x/y の整数の商の絶対値と $modulo 2 n$ で合同な値を格納します。ただし $n$ は $3$ より大きいまたは等しい処理系定義の整数です)。

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

定義域エラーが発生した場合、処理系定義の値 (サポートされていれば 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)$ を計算するとき、 sin を直接呼ぶと大きな誤差が発生する可能性がありますが、まず引数を remquo で縮小すれば、商の下位ビットを周期内の結果の象限と符号を決めるために使用することができ、余りを高精度な値を計算するために使用することができます。

プラットフォームによっては、この演算はハードウェアでサポートされています (例えば Intel CPU では、 FPREM1 は完了時にちょうど3ビットの精度の商を残します)。

例

Run this code

#include <stdio.h>
#include <math.h>
#include <fenv.h>

#pragma STDC FENV_ACCESS ON
double cos_pi_x_naive(double x)
{
    double pi = acos(-1);
    return cos(pi * x);
}
// the period is 2, values are (0;0.5) positive, (0.5;1.5) negative, (1.5,2) positive
double cos_pi_x_smart(double x)
{
    int quadrant;
    double rem = remquo(x, 1, &quadrant);
    quadrant = (unsigned)quadrant % 4; // keep 2 bits to determine quadrant

    double pi = acos(-1);
    switch(quadrant) {
        case 0: return cos(pi * rem);
        case 1: return -cos(pi * rem);
        case 2: return -cos(pi * rem);
        case 3: return cos(pi * rem);
    };
}
int main(void)
{
    printf("cos(pi * 0.25) = %f\n", cos_pi_x_naive(0.25));
    printf("cos(pi * 1.25) = %f\n", cos_pi_x_naive(1.25));
    printf("cos(pi * 1000000000000.25) = %f\n", cos_pi_x_naive(1000000000000.25));
    printf("cos(pi * 1000000000001.25) = %f\n", cos_pi_x_naive(1000000000001.25));
    printf("cos(pi * 1000000000000.25) = %f\n", cos_pi_x_smart(1000000000000.25));
    printf("cos(pi * 1000000000001.25) = %f\n", cos_pi_x_smart(1000000000001.25));
    // error handling
    feclearexcept(FE_ALL_EXCEPT);
    int quo;
    printf("remquo(+Inf, 1) = %.1f\n", remquo(INFINITY, 1, &quo));
    if(fetestexcept(FE_INVALID)) puts("    FE_INVALID raised");
}

出力例:

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

参考文献

C11 standard (ISO/IEC 9899:2011):

7.12.10.3 The remquo functions (p: 255)

7.25 Type-generic math <tgmath.h> (p: 373-375)

F.10.7.3 The remquo functions (p: 529)

C99 standard (ISO/IEC 9899:1999):

7.12.10.3 The remquo functions (p: 236)

7.22 Type-generic math <tgmath.h> (p: 335-337)

F.9.7.3 The remquo functions (p: 465)

divldivlldiv (C99)	整数除算の商と余りを計算します (関数) [edit]
fmodfmodffmodl (C99)(C99)	浮動小数点除算の余りを計算します (関数) [edit]
remainderremainderfremainderl (C99)(C99)(C99)	浮動小数点除算の符号付きの余りを計算します (関数) [edit]
remquo の C++リファレンス

cppreference.com

検索

名前空間

変種

表示

操作

remquo, remquof, remquol

目次

引数

戻り値

エラー処理

ノート

例

参考文献

関連項目

案内

ツール

x, y	-	浮動小数点値
quo	-	`x/y` の符号といくつかのビットを格納するための整数値を指すポインタ