std::mul_sat

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名需求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

数值库

常用数学函数
数学特殊函数 (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 mul_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。

特性测试 宏	值	Std	特性
__cpp_lib_saturation_arithmetic	202311L	(C++26)	饱和算术

可能的实现

参见 libstdc++ (gcc)。

示例

可以在 编译器资源管理器 上预览。

运行此代码

#include <climits>
#include <numeric>
 
static_assert
(""
    && (std::mul_sat<int>(2, 3) == 6) // not saturated
    && (std::mul_sat<int>(INT_MAX / 2, 3) == INT_MAX) // saturated
    && (std::mul_sat<int>(-2, 3) == -6) // not saturated
    && (std::mul_sat<int>(INT_MIN / -2, -3) == INT_MIN) // saturated
    && (std::mul_sat<unsigned>(2, 3) == 6) // not saturated
    && (std::mul_sat<unsigned>(UINT_MAX / 2, 3) == UINT_MAX) // saturated
);
 
int main() {}

另请参阅

add_sat (C++26)	对两个整数执行饱和加法操作 (函数模板)
sub_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.	饱和算术的无分支实现 — Locklessinc.com，2012