std::clamp

定义于头文件 `<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 起) 来比较值。

如果 T 不是 LessThanComparable，则行为未定义。^[1]

2) 使用比较函数 comp 来比较值。

如果 lo 大于 hi，则行为未定义。

↑ 如果避免使用 NaN，则 T 可以是浮点类型。

虽然签名不需要具有 const&，但该函数不得修改传递给它的对象，并且必须能够接受类型为 Type1 和 Type2 的所有值，而与值类别无关（因此，不允许使用 Type1&，也不允许使用 Type1，除非对于 Type1，移动等效于复制(自 C++11 起)）。
类型 Type1 和 Type2 必须使得类型为 T 的对象可以隐式转换为这两种类型。

[编辑] 返回值

如果 v 小于 lo，则返回对 lo 的引用；如果 hi 小于 v，则返回对 hi 的引用；否则返回对 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 而不是边界的引用。

特性测试宏	值	Std	特性
`__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

[编辑] 参见

min	返回给定值中较小的值 (函数模板) [编辑]
max	返回给定值中较大的值 (函数模板) [编辑]
in_range (C++20)	检查整数值是否在给定整数类型的范围内 (函数模板) [编辑]
ranges::clamp (C++20)	将值钳制在一对边界值之间 (算法函数对象)[编辑]

[1] 如果避免使用 NaN，则 T 可以是浮点类型。

[1]

编译器支持
独立和宿主
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

cppreference.cn

命名空间

变体

视图

操作