std::add_sat

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

数值库

常用数学函数
数学特殊函数 (C++17)
数学常数 (C++20)
基本线性代数算法 (C++26)
浮点环境 (C++11)
复数
数值数组 (valarray)
伪随机数生成
因数运算
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)
位操作
has_single_bit (C++20)     bit_cast (C++20) bit_ceil (C++20) bit_floor (C++20) bit_width (C++20) rotl (C++20) rotr (C++20)	popcount (C++20) countl_zero (C++20) countl_one (C++20) countr_zero (C++20) countr_one (C++20) byteswap (C++23) endian (C++20)

 

在标头 <numeric> 定义
template< class T > constexpr T add_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 <limits>
#include <numeric>
 
static_assert(CHAR_BIT == 8);
static_assert(UCHAR_MAX == 255);
 
int main()
{
    constexpr int a = std::add_sat(3, 4); // 未饱和, T = int
    static_assert(a == 7);
 
    constexpr unsigned char b = std::add_sat<unsigned char>(UCHAR_MAX, 4); // 饱和
    static_assert(b == UCHAR_MAX);
 
    constexpr unsigned char c = std::add_sat(UCHAR_MAX, 4); // 未饱和, T = int
        // add_sat(int, int) 返回 int tmp == 259,
        // 然后赋值时截断 259 % 256 == 3
    static_assert(c == 3);
 
//  unsigned char d = std::add_sat(252, c); // 错误：T 的推导不一致
 
    constexpr unsigned char e = std::add_sat<unsigned char>(251, a); // 饱和
    static_assert(e == UCHAR_MAX);
        // 251 类型为 T = unsigned char, `a` 被转换为 unsigned char 值;
        // 可能引发 `a` 的 int -> unsigned char 转换警告
 
    constexpr signed char f = std::add_sat<signed char>(-123, -3); // 未饱和
    static_assert(f == -126);
 
    constexpr signed char g = std::add_sat<signed char>(-123, -13); // 饱和
    static_assert(g == std::numeric_limits<signed char>::min()); // g == -128
}

参阅

sub_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