std::clamp

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

算法库

受约束算法及范围上的算法 (C++20)
受约束算法： std::ranges::copy, std::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)
不修改序列的操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	search search_n lexicographical_compare lexicographical_compare_three_way (C++20)	findfind_iffind_if_not (C++11) find_end find_first_of
修改序列的操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17 前)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
Partitioning operations
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
划分操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
排序操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
二分搜索操作
lower_bound	upper_bound	binary_search	equal_range
集合操作（在已排序范围上）
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
堆操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大操作
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
排列
is_permutation (C++11)	next_permutation	prev_permutation
数值运算
iota (C++11) inner_product adjacent_difference	accumulate reduce (C++17) transform_reduce (C++17)	transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)	partial_sum inclusive_scan (C++17) 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	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)
C 库
qsort	bsearch

 

在标头 <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 小于 lo ，则返回 lo ；若 v 大于 hi ，则返回 hi ；否则返回 v 。使用 operator< 比较值。

2) 同 (1) ，不过使用 comp 比较值。

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

参数

v	-	要夹住的值
lo,hi	-	夹 v 的边界
comp	-	比较函数对象（即满足比较 (Compare) 要求的对象），如果 lo 小于 v 且 v 小于 hi，那么返回 ​true。 比较函数的签名应等价于如下：  bool cmp(const Type1 &a, const Type2 &b); 虽然签名不必有 const &，函数也不能修改传递给它的对象，而且必须接受（可有 const 限定的）类型 Type1 与 Type2 的值，与值类别无关（从而不允许 Type1 &，也不允许 Type1，除非 Type1 的移动等价于复制 (C++11 起)）。 类型 Type1 与 Type2 必须使得 T 类型的对象能隐式转换到这两个类型。 ​
类型要求
- 为使用重载 (1)， T 必须符合可小于比较 (LessThanComparable) 的要求。然而若避免了 NaN ，则 T 能为浮点类型。

返回值

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

复杂度

至多二次比较

可能的实现

版本一
template<class T> constexpr const T& clamp( const T& v, const T& lo, const T& hi ) { assert( !(hi < lo) ); return v < lo ? lo : hi < v ? hi : v; }
版本二
template<class T, class Compare> constexpr const T& clamp( const T& v, const T& lo, const T& hi, Compare comp ) { assert( !comp(hi, lo) ); return 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 的引用，而非到边界者。

示例

运行此代码

#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

参阅

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