std::sub_sat

 

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)

 

定義於標頭檔案 <numeric>
template< class T > constexpr T sub_sat( T x, T y ) noexcept;		(C++26 起)

計算飽和減法 x - y。此操作（與內建整數算術操作不同）的行為如同是一個具有無限範圍的數學操作。設q表示此類操作的結果。返回

• q，如果q可以表示為型別T的值。否則，
• 型別T的最大值或最小值，以更接近q的為準。

此過載僅在T是整數型別時才參與過載決議，即：signed char, short, int, long, long long，擴充套件的有符號整數型別，或這些型別的無符號版本。特別地，T不得為（可能是cv限定的）bool, char, wchar_t, char8_t, char16_t, 和 char32_t，因為這些型別不用於算術運算。

引數

x, y

-

整數值

返回值

飽和的 x - y。

注意

與內建整數算術運算子不同，整型提升不適用於 x 和 y 引數。

如果傳入兩個不同型別的引數，呼叫將無法編譯，即相對於模板引數推導的行為與std::min或std::max相同。

大多數現代硬體架構都高效支援 SIMD 向量上的飽和算術，包括 x86 上的 SSE2 和 ARM 上的 NEON。

特性測試宏	值	標準	特性
__cpp_lib_saturation_arithmetic	202311L	(C++26)	飽和算術

可能實現

參見 libstdc++ (gcc)。

示例

可在 Compiler Explorer 上預覽

執行此程式碼

#include <climits>
#include <numeric>
 
static_assert
(""
    && (std::sub_sat<int>(INT_MIN + 4, 3) == INT_MIN + 1) // not saturated
    && (std::sub_sat<int>(INT_MIN + 4, 5) == INT_MIN) // saturated
    && (std::sub_sat<int>(INT_MAX - 4, -3) == INT_MAX - 1) // not saturated
    && (std::sub_sat<int>(INT_MAX - 4, -5) == INT_MAX) // saturated
    && (std::sub_sat<unsigned>(4, 3) == 1) // not saturated
    && (std::sub_sat<unsigned>(4, 5) == 0) // saturated
);
 
int main() {}

另請參閱

add_sat (C++26)	對兩個整數進行飽和加法運算 (函式模板)
mul_sat (C++26)	對兩個整數進行飽和乘法運算 (函式模板)
div_sat (C++26)	對兩個整數進行飽和除法運算 (函式模板)
saturate_cast (C++26)	返回一個整數值，該值被鉗制在另一個整數型別的範圍內 (函式模板)
clamp (C++17)	將值限制在邊界值對之間 (函式模板)
in_range (C++20)	檢查整數值是否在給定整數型別的範圍內 (函式模板)
min [靜態]	返回給定非浮點型別的最小有限值，或給定浮點型別的最小正規化值 (std::numeric_limits<T> 的公共靜態成員函式)
max [靜態]	返回給定型別的最大有限值 (std::numeric_limits<T> 的公共靜態成員函式)

外部連結

1.	A branch-free implementation of saturation arithmetic — Locklessinc.com, 2012
2.	C++ Weekly - Ep 459 - C++26's Saturating Math Operations — Youtube.com, 2024-12-16