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

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

ファイルシステムライブラリ (C++17)

技術仕様書

 

数値演算ライブラリ

一般的な数学関数

特殊な数学関数 (C++17)

数学定数 (C++20)

浮動小数点環境 (C++11)

複素数

数値配列

擬似乱数生成

コンパイル時有理数算術 (C++11)

数値演算アルゴリズム

gcd (C++17)

lcm (C++17)

補間

midpoint (C++20)

lerp (C++20)

汎用の数値演算

iota (C++11)

accumulate

inner_product

adjacent_difference

partial_sum

reduce (C++17)

transform_reduce (C++17)

inclusive_scan (C++17)

exclusive_scan (C++17)

transform_inclusive_scan (C++17)

transform_exclusive_scan (C++17)

ビット操作

bit_cast (C++20)

ispow2 (C++20)

ceil2 (C++20)

floor2 (C++20)

log2p1 (C++20)

rotl (C++20)

rotr (C++20)

countl_zero (C++20)

countl_one (C++20)

countr_zero (C++20)

countr_one (C++20)

popcount (C++20)

endian (C++20)

 

一般的な数学関数

関数
基本的な演算
abs(int)labsllabsimaxabs (C++11) abs(float)fabs divldivlldivimaxdiv (C++11) fmod	remainder (C++11) remquo (C++11) fma (C++11) fmax (C++11) fmin (C++11) fdim (C++11) nannanfnanl (C++11)(C++11)(C++11)
指数関数
exp exp2 (C++11) expm1 (C++11)	log log10 log1p (C++11) log2 (C++11)
冪関数
sqrt cbrt (C++11)	hypot (C++11) pow
三角関数と双曲線関数
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)

誤差関数とガンマ関数
erf (C++11) erfc (C++11)	lgamma (C++11) tgamma (C++11)
最も近い整数
ceil floor roundlroundllround (C++11)(C++11)(C++11)	trunc (C++11) nearbyint (C++11) rintlrintllrint (C++11)(C++11)(C++11)
浮動小数点操作関数
ldexp scalbnscalbln (C++11)(C++11) ilogb (C++11) logb (C++11)	frexp modf nextafternexttoward (C++11)(C++11) copysign (C++11)
分類および比較
fpclassify (C++11) isfinite (C++11) isinf (C++11) isnan (C++11) isnormal (C++11) signbit (C++11)	isgreater (C++11) isgreaterequal (C++11) isless (C++11) islessequal (C++11) islessgreater (C++11) isunordered (C++11)
マクロ定数
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) INFINITY (C++11) NAN (C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)	FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

ヘッダ <cmath> で定義
float       remainder ( float x, float y ); float       remainderf( float x, float y );	(1)	(C++11以上)
double      remainder ( double x, double y );	(2)	(C++11以上)
long double remainder ( long double x, long double y ); long double remainderl( long double x, long double y );	(3)	(C++11以上)
昇格後の型    remainder ( 算術型1 x, 算術型2 y );	(4)	(C++11以上)

1-3) 浮動小数点除算 x/y の IEEE 剰余を計算します。

4) (1-3) でカバーされない算術型の引数のすべての組み合わせに対するオーバーロード集合または関数テンプレート。 いずれかの引数が整数型の場合、それは double にキャストされます。 他のいずれかの引数が long double の場合、戻り値型は long double になり、そうでなければ double になります。

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

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

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

引数

x, y

-

浮動小数点型または整数型の値

戻り値

成功した場合、上で定義された通りの除算 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] の範囲内になります。

例

Run this code

#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

関連項目

div(int)ldivlldiv (C++11)	整数除算の商と余りを計算します (関数)
fmodfmodffmodl (C++11)(C++11)	浮動小数点除算の余りを計算します (関数)
remquoremquofremquol (C++11)(C++11)(C++11)	除算の下位3ビットと符号付きの余りを計算します (関数)
remainder の C言語リファレンス