std::ranges::clamp

定义在头文件 `<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, hi] 之内，则返回 v；否则返回最接近的边界。

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

此页面上描述的函数式实体是niebloids，即

在调用它们时不能指定显式模板参数列表。
它们都不对依赖于参数的查找可见。
当它们中的任何一个通过普通的非限定查找作为函数调用运算符左侧的名称被找到时，依赖于参数的查找将被禁止。

实际上，它们可以被实现为函数对象，或者使用特殊的编译器扩展。

[编辑] 参数

v	-	要钳制的 value
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 = std::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);
 
        if (std::invoke(comp, std::forward<decltype(pv)>(pv), std::invoke(proj, lo)))
            return lo;
 
        if (std::invoke(comp, std::invoke(proj, hi), std::forward<decltype(pv)>(pv)))
            return hi;
 
        return v;
    }
};
 
inline constexpr clamp_fn clamp;

[编辑] 备注

[编辑]

如果其中一个参数是临时变量并且该参数被返回，则通过引用捕获 std::ranges::clamp 的结果会产生悬空引用

int n = -1;
const int& r = std::ranges::clamp(n, 0, 255); // r is dangling

如果 v 与任何一个边界比较相等，则返回对 v 的引用，而不是边界。

如果投影函数返回值，且比较器按值接受参数，那么此函数不应同时使用这两个函数，除非从投影结果类型到比较器参数类型的移动等效于复制。如果通过 std::invoke 进行比较会改变投影的结果，则由于 std::regular_invocable 的语义要求（包含在 std::indirect_strict_weak_order 中），行为将是未定义的。

标准要求投影结果的值类别保持不变，而 proj 只能在 v 上调用一次，这意味着对于比较器两次调用，必须缓存并从 prvalue 投影结果中移动两次。

libstdc++ 不符合此标准，始终将投影结果作为左值传递。
libc++ 曾经两次运行投影，但在 Clang 18 中已更正。
MSVC STL 曾经两次运行投影，但在 VS 2022 17.2 中已更正。

[edit] 示例

运行此代码

#include <algorithm>
#include <cstdint>
#include <iomanip>
#include <iostream>
#include <string>
 
using namespace std::literals;
namespace ranges = std::ranges;
 
int main()
{
    std::cout << "[raw] [" << INT8_MIN << ',' << INT8_MAX << "] "
                 "[0" << ',' << UINT8_MAX << "]\n";
    for (int const v : {-129, -128, -1, 0, 42, 127, 128, 255, 256})
        std::cout << std::setw(4) << v
                  << std::setw(11) << ranges::clamp(v, INT8_MIN, INT8_MAX)
                  << std::setw(8) << ranges::clamp(v, 0, UINT8_MAX) << '\n';
    std::cout << std::string(23, '-') << '\n';
 
    // Projection function
    const auto stoi = [](std::string s) { return std::stoi(s); };
 
    // Same as above, but with strings
    for (std::string const v : {"-129", "-128", "-1", "0", "42",
                                "127", "128", "255", "256"})
        std::cout << std::setw(4) << v
                  << std::setw(11) << ranges::clamp(v, "-128"s, "127"s, {}, stoi)
                  << std::setw(8) << ranges::clamp(v, "0"s, "255"s, {}, stoi)
                  << '\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
-----------------------
-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

[edit] 另请参阅

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

编译器支持
独立和托管
语言
标准库
标准库头文件
命名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

cppreference.com

命名空间

变体

视图

操作