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