std::ranges::clamp
定义于头文件 <algorithm>
|
||
调用签名 |
||
template< class T, class Proj = std::identity, std::indirect_strict_weak_order<std::projected<const T*, Proj>> Comp = ranges::less > |
(C++20 起) | |
若 v
比较小于 lo
则返回 lo
;否则若 hi
比较小于 v
则返回 hi
;否则返回 v
。
若 lo
的被投影值大于 hi
则行为未定义。
此页面上描述的仿函数实体是 niebloid ,即:
实际上,它们能以函数对象,或以某些特殊编译器扩展实现。
参数
v | - | 待夹的值 |
lo, hi | - | 用以夹 v 的边界
|
comp | - | 应用到投影后元素的比较 |
proj | - | 应用到 v 、 lo 及 hi 的投影
|
返回值
若 v
的被投影值小于 lo
的被投影值则为到 lo
的引用,若 hi
的被投影值小于 v
的被投影值则为 hi
到的引用,否则为到 v
的引用。
复杂度
至多应用二次比较和三次投影。
可能的实现
struct clamp_fn { template<class T, class Proj = std::identity, std::indirect_strict_weak_order<std::projected<const T*, Proj>> Comp = ranges::less> constexpr const T& operator()(const T& v, const T& lo, const T& hi, Comp comp = {}, Proj proj = {}) const { assert(!std::invoke(comp, std::invoke(proj, hi), std::invoke(proj, lo))); return std::invoke(comp, std::invoke(proj, v), std::invoke(proj, lo)) ? lo : std::invoke(comp, std::invoke(proj, hi), std::invoke(proj, v)) ? hi : v; } }; inline constexpr clamp_fn clamp; |
注解
std::ranges::clamp
的结果会产生一个悬垂引用:
int n = 1; const int& r = std::ranges::clamp(n-1, n+1); // r 悬垂
若 v
与任一边界比较等价,则返回到 v
而非到边界的引用。
示例
运行此代码
#include <algorithm> #include <cstdint> #include <iostream> #include <iomanip> #include <random> int main() { std::mt19937 g(std::random_device{}()); std::uniform_int_distribution<> d(-300, 300); std::cout << " raw clamped to int8_t clamped to uint8_t\n"; for(int n = 0; n < 5; ++n) { int v = d(g); std::cout << std::setw(4) << v << std::setw(20) << std::ranges::clamp(v, INT8_MIN, INT8_MAX) << std::setw(21) << std::ranges::clamp(v, 0, UINT8_MAX) << '\n'; } }
可能的输出:
.raw clamped to int8_t clamped to uint8_t 168 127 168 128 127 128 -137 -128 0 40 40 40 -66 -66 0
参阅
(C++20) |
返回给定值的较小者 (niebloid) |
(C++20) |
返回给定值的较大者 (niebloid) |
(C++17) |
在一对边界值间夹逼一个值 (函数模板) |