基本信息
- 所在头文件:algorithm (C++ 17及以上)
- 所在命名空间:std
- 函数原型:
// 共 2 个重载
template<class _Ty>
_NODISCARD constexpr const _Ty& clamp(const _Ty& _Val, const _Ty& _Min_val, const _Ty& _Max_val);
template <class _Ty, class _Pr>
_NODISCARD constexpr const _Ty& clamp(const _Ty& _Val, const _Ty& _Min_val, const _Ty& _Max_val, _Pr _Pred);
注:来自 MSVC 14.32.31326
解释
为了更好理解,我们对标准库的 std::clamp 整理一下,如下:
template<typename T>
constexpr const T& clamp(const T& value, const T& min_value, const T& max_value);
!!!注意:min_value 一定要小于等于 max_value
这里只展示比较常用的这个重载。
做一个不恰当的比喻:正如名字 clamp – 钳子,利用参数 min_value 和 max_value 设置了一个范围,而这个范围就好比是 ”钳嘴“,将返回值限制在这个 ”钳嘴“ 之间,范围为 [min_value, max_value]。
特别的是,返回值是一个引用,这个引用只会是 value,min_value 和 max_value 中的一个。
规则:
- 若 value <= min_value,返回 min_value 的引用
- 若 value >= max_value,返回 max_value 的引用
- 若 min_value < value < max_value,返回 value 的引用
示例
#include <iostream>
#include <algorithm>
using namespace std;
void foo(int a, int b, int c)
{
// 打印传入参数
cout << "[ "<< a << " | " << b << " | " << c <<" ]" << endl;
// 打印输出结果
cout << "-> " << clamp(a, b, c) << endl << endl;
}
int main()
{
foo(1, 10, 20);
foo(10, 10, 20);
foo(15, 10, 20);
foo(25, 10, 20);
}
运行结果: