std::ranges::clamp

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

算法库

有约束算法与针对范围的算法 (C++20)
有约束的算法，例如 ranges::copy、 ranges::sort 等……
执行策略 (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
非修改序列操作 批量操作 for_each for_each_n (C++17) 搜索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n 修改序列操作 复制操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) 交换操作 swap iter_swap swap_ranges 变换操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 移除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 顺序变换操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17 前)(C++11) shift_leftshift_right (C++20)(C++20) 采样操作 sample (C++17)	排序及相关操作 划分操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) 排序操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分搜索操作 （于已划分范围上） lower_bound upper_bound equal_range binary_search 集合操作（于已排序范围上） includes set_union set_intersection set_difference set_symmetric_difference 归并操作（于已排序范围上） merge inplace_merge 堆操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大值操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 字典序比较操作 lexicographical_compare lexicographical_compare_three_way (C++20) 排列操作 next_permutation prev_permutation is_permutation (C++11) C 库 qsort bsearch
数值操作
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初始化内存上的操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

受约束算法

此菜单中的所有名称均属于命名空间 std::ranges

非修改序列操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

修改序列操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

划分操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

排序操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分查找操作（在已排序的范围内）

lower_bound         upper_bound         binary_search      equal_range

集合操作（于已排序范围上）

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

堆操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大值操作

max max_element         min min_element         minmax minmax_element     clamp

排列操作

is_permutation      next_permutation    prev_permutation

折叠操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

数值操作 iota (C++23)             随机数生成 generate_random (C++26)

对未初始化存储的操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

返回类型

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

定义于头文件 <algorithm>
调用签名 (Call signature)
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	-	要限制的值
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 subsume），行为未定义。

标准要求保留投影结果的值类别，并且 proj 只能在 v 上调用一次，这意味着 prvalue 的投影结果必须被缓存并为比较器的两次调用移动两次。

• libstdc++ 不符合此要求，并且总是将投影结果作为左值传递。
• libc++ 曾两次运行投影，这在 Clang 18 中得到了纠正。
• MSVC STL 曾两次运行投影，这在 VS 2022 17.2 中得到了纠正。

示例

运行此代码

#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

参阅

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