std::clamp
来自 zh.cppreference.net
| 定义于头文件 <algorithm>
|
||
template< class T >
constexpr const T& clamp( const T& v, const T& lo, const T& hi );
|
(1) | (C++17 起) |
template< class T, class Compare >
constexpr const T& clamp( const T& v, const T& lo, const T& hi,
Compare comp );
|
(2) | (C++17 起) |
如果 v 的值在 [lo, hi] 范围内,则返回 v;否则返回最邻近的边界值。
1) 使用
operator<(C++20 前)std::less{}(C++20 起) 比较值。2) 使用比较函数
comp 比较值。 如果 lo 大于 hi,则行为未定义。
- ↑ 如果避免使用
NaN,那么T可以是浮点类型。
参数
| v | - | 要夹取的值 |
| lo, hi | - | 将 v 夹取到的边界值
|
| comp | - | 比较函数对象(即满足 Compare 要求的对象),它返回 true,如果第一个参数小于第二个。比较函数的签名应等价于如下:
虽然签名不需要有 |
返回值
对 lo 的引用,如果 v 小于 lo;对 hi 的引用,如果 hi 小于 v;否则对 v 的引用。
复杂度
1) 至多两次使用
operator<(C++20 前)std::less{}(C++20 起) 的比较。2) 至多两次应用比较函数
comp。可能的实现
| clamp (1) |
|---|
template<class T>
constexpr const T& clamp(const T& v, const T& lo, const T& hi)
{
return clamp(v, lo, hi, less{});
}
|
| clamp (2) |
template<class T, class Compare>
constexpr const T& clamp(const T& v, const T& lo, const T& hi, Compare comp)
{
return comp(v, lo) ? lo : comp(hi, v) ? hi : v;
}
|
注解
如果某个参数是临时对象且返回该参数,则通过引用捕获 std::clamp 的结果会产生悬垂引用:
int n = -1;
const int& r = std::clamp(n, 0, 255); // r is dangling
如果 v 与任一边界比较等价,则返回对 v 的引用,而不是边界。
| 功能特性测试宏 | 值 | 标准 | 特性 |
|---|---|---|---|
__cpp_lib_clamp |
201603L |
(C++17) | std::clamp
|
示例
运行此代码
#include <algorithm>
#include <cstdint>
#include <iomanip>
#include <iostream>
int main()
{
std::cout << "[raw] "
"[" << INT8_MIN << ',' << INT8_MAX << "] "
"[0," << UINT8_MAX << "]\n";
for (const int v : {-129, -128, -1, 0, 42, 127, 128, 255, 256})
std::cout << std::setw(4) << v
<< std::setw(11) << std::clamp(v, INT8_MIN, INT8_MAX)
<< std::setw(8) << std::clamp(v, 0, UINT8_MAX) << '\n';
}
输出:
[raw] [-128,127] [0,255]
-129 -128 0
-128 -128 0
-1 -1 0
0 0 0
42 42 42
127 127 127
128 127 128
255 127 255
256 127 255
参阅
| 返回给定值中的较小者 (函数模板 & 算法函数对象) | |
(C++20) |
|
| 返回给定值中的较大者 (函数模板 & 算法函数对象) | |
(C++20) |
|
(C++20) |
检查整数值是否在给定的整数类型的范围内 (函数模板) |
(C++20) |
将值限制在一对边界值之间 (算法函数对象) |