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

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

數值庫

常用數學函式
數學特殊函式 (C++17)
數學常數 (C++20)
基本線性代數演算法 (C++26)
資料並行型別 (SIMD) (C++26)
浮點環境 (C++11)
複數
數值陣列 (valarray)
偽隨機數生成
位操作 (C++20)
因子運算
gcd (C++17)	lcm (C++17)
插值
midpoint (C++20)	lerp (C++20)
飽和算術
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
通用數值運算
iota (C++11) ranges::iota (C++23) 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)

 

常用數學函式

函式
基本操作
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)
型別
div_t ldiv_t lldiv_t (C++11)	imaxdiv_t (C++11) float_t (C++11) double_t (C++11)
宏常量
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)   INFINITY (C++11) NAN (C++11)	分類 FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

定義於標頭檔案 <cmath>
	(1)
float       remainder ( float x, float y ); double      remainder ( double x, double y ); long double remainder ( long double x, long double y );			(直至 C++23)
constexpr /*浮點型別*/             remainder ( /*浮點型別*/ x,                         /*浮點型別*/ y );			(C++23 起)
float       remainderf( float x, float y );		(2)	(C++11 起) (C++23 起為 constexpr)
long double remainderl( long double x, long double y );		(3)	(C++11 起) (C++23 起為 constexpr)
SIMD 過載 (C++26 起)
定義於標頭檔案 <simd>
template< class V0, class V1 > constexpr /*math-common-simd-t*/<V0, V1>             remainder ( const V0& v_x, const V1& v_y );		(S)	(C++26 起)
額外過載 (自 C++11 起)
定義於標頭檔案 <cmath>
template< class Integer > double      remainder ( Integer x, Integer y );		(A)	(C++23 起為 constexpr)

1-3) 計算浮點除法運算 x / y 的 IEEE 餘數。 庫為所有 cv-unqualified 浮點型別提供了 std::remainder 的過載作為引數的型別。(C++23 起)

S) SIMD 過載對 v_x 和 v_y 執行逐元素的 std::remainder。 (參閱 math-common-simd-t 的定義。)

(C++26 起)

A) 為所有整數型別提供了額外的過載，它們被視為 double。

(C++11 起)

此函式計算的除法運算 x / y 的 IEEE 浮點餘數正好是值 x - quo * y，其中值 quo 是最接近精確值 x / y 的整數值。當 |quo - x / y| = ½ 時，值 quo 被選擇為偶數。

與 std::fmod 不同，返回值的符號不保證與 x 相同。

如果返回值為零，則其符號與 x 相同。

引數

x, y

-

浮點數或整數值

返回值

如果成功，返回如上定義的除法 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

如果 num1 或 num2 的型別為 long double，則 std::remainder(num1, num2) 的效果與 std::remainder(static_cast<long double>(num1),                static_cast<long double>(num2)) 相同。 否則，如果 num1 和/或 num2 的型別為 double 或整數型別，則 std::remainder(num1, num2) 的效果與 std::remainder(static_cast<double>(num1),                static_cast<double>(num2)) 相同。 否則，如果 num1 或 num2 的型別為 float，則 std::remainder(num1, num2) 的效果與 std::remainder(static_cast<float>(num1),                static_cast<float>(num2)) 相同。

(直至 C++23)

如果 num1 和 num2 具有算術型別，則 std::remainder(num1, num2) 的效果與 std::remainder(static_cast</*common-floating-point-type*/>(num1),                static_cast</*common-floating-point-type*/>(num2)) 相同，其中 /*common-floating-point-type*/ 是具有最高 浮點轉換等級 和最高 浮點轉換子等級 的浮點型別，介於 num1 和 num2 的型別之間，整數型別的引數被認為與 double 具有相同的浮點轉換等級。 如果不存在具有最高等級和次等級的浮點型別，則過載決議不會從提供的過載中產生可用的候選函式。

(C++23 起)

示例

執行此程式碼

#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

參閱

div(int)ldivlldiv (C++11)	計算整數除法的商和餘數 (函式)
fmodfmodffmodl (C++11)(C++11)	浮點除法運算的餘數 (函式)
remquoremquofremquol (C++11)(C++11)(C++11)	帶符號餘數以及除法運算的最後三位 (函式)
C 文件 為 remainder