# std::ranges::clamp

< cpp‎ | algorithm‎ | ranges

定义于头文件 `<algorithm>` |  |
调用签名 |  |
template< class T, class Proj = std::identity, std::indirect_strict_weak_order<std::projected<const T*, Proj>> Comp = ranges::less > constexpr const T& clamp( const T& v, const T& lo, const T& hi, Comp comp = {}, Proj proj = {} ); |  | (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
      {
          auto&& pv = std::invoke(proj, v);

          return std::invoke(comp, std::forward<decltype(pv)>(pv), std::invoke(proj, lo)) ? lo
               : std::invoke(comp, std::invoke(proj, hi), std::forward<decltype(pv)>(pv)) ? 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 <string>

    using namespace std::literals;

    int main()
    {
        std::cout << " raw   clamped to int8_t   clamped to uint8_t\n";
        for(int const v: {-129, -128, -1, 0, 42, 127, 128, 255, 256}) {
            std::cout << std::setw(04) << v
                      << std::setw(20) << std::ranges::clamp(v, INT8_MIN, INT8_MAX)
                      << std::setw(21) << std::ranges::clamp(v, 0, UINT8_MAX) << '\n';
        }
        std::cout << '\n';

        // 投影函数
        const auto stoi = [](std::string s) { return std::stoi(s); };

        // 同上，但用字符串
        for(std::string const v: {"-129", "-128", "-1", "0", "42", "127", "128", "255", "256"}) {
            std::cout << std::setw(04) << v
                      << std::setw(20) << std::ranges::clamp(v, "-128"s, "127"s, {}, stoi)
                      << std::setw(21) << std::ranges::clamp(v, "0"s, "255"s, {}, stoi) << '\n';
        }
    }

输出：

     raw   clamped to int8_t   clamped to uint8_t
    -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

    -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

### 参阅

ranges::min (C++20) | 返回给定值的较小者 (niebloid)
ranges::max (C++20) | 返回给定值的较大者 (niebloid)
in_range (C++20) | 检查整数值是否在给定整数类型的范围内 (函数模板)
clamp (C++17) | 在一对边界值间夹逼一个值 (函数模板)