std::clamp

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
执行策略 (C++17)
不修改序列的操作
(C++11)
(C++11)
(C++11)
(C++17)
修改序列的操作
未初始化存储上的操作
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
(C++11)
clamp
(C++17)
排列
数值运算
C 库
 
定义于头文件 <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 起)
1)v 比较小于 hi ,则返回 vlo 的较大者,否则返回 vhi 的较小者。使用 operator< 比较值。
2)(1) ,不过使用 comp 比较值。

lo 的值大于 hi 则行为未定义。

目录

[编辑] 参数

v - 要夹住的值
lo,hi - v 的边界
comp - 比较函数对象(即满足比较 (Compare) 要求的对象),若 lo 小于 vv 小于 hi,则返回 ​true

比较函数的签名应等价于如下者:

 bool cmp(const Type1 &a, const Type2 &b);

签名不需要拥有 const & ,但函数对象必须不修改传递给它的对象。
类型 Type1Type2 必须使得 T 类型的对象能隐式转换到这两个类型。 ​

类型要求
-
为使用重载 (1) , T 必须满足 LessThanComparable 的要求。

[编辑] 返回值

v 小于 lo 到则为 lo 的引用,若 hi 小于 v 则为到 hi 的引用,否则为到 v 的引用。

[编辑] 复杂度

1) 至多二次比较

[编辑] 可能的实现

版本一
template<class T>
constexpr const T& clamp( const T& v, const T& lo, const T& hi )
{
    return clamp( v, lo, hi, std::less<>() );
}
版本二
template<class T, class Compare>
constexpr const T& clamp( const T& v, const T& lo, const T& hi, Compare comp )
{
    return assert( !comp(hi, lo) ),
        comp(v, lo) ? lo : comp(hi, v) ? hi : v;
}

[编辑] 注意

若参数之一是右值,且返回该参数,则以引用捕获 std::clamp 的结果会产生一个悬垂引用:
int n = -1;
const int& r = std::clamp(n, 0, 255);
// r 为悬垂

v 与边界之一比较相等,则返回到 v 的引用,而非到边界者。

仅若排除了 NaN 才对浮点的 T 有效。

[编辑] 示例

#include <cstdint>
#include <algorithm>
#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::clamp(v, INT8_MIN, INT8_MAX)
                  << std::setw(21) << std::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


[编辑] 参阅

返回两个元素中的较小者
(函数模板) [编辑]
返回两个元素中的较大者
(函数模板) [编辑]