std::clamp

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ(C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

ファイルシステムライブラリ(C++17)

技術仕様書

 

アルゴリズムライブラリ

制約付きアルゴリズムと範囲に対するアルゴリズム (C++20)
コンセプトとユーティリティ (std::Sortable, std::projected, ... )
制約付きアルゴリズム (std::ranges::copy, std::ranges::sort, ... )
実行ポリシー (C++17)
is_execution_policy	execution::seqexecution::parexecution::par_unseqexecution::unseq (C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (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	findfind_iffind_if_not (C++11) find_end find_first_of	search search_n lexicographical_compare lexicographical_compare_3way (C++20)
変更シーケンス操作
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)
未初期化記憶域の操作
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) destroy (C++17)	uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17)
分割操作
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) compare_3way (C++20)
順列
is_permutation (C++11)	next_permutation	prev_permutation
数値演算
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)
C のライブラリ
qsort	bsearch

 

ヘッダ <algorithm> で定義
template<class T> constexprconst T& clamp(const T& v, const T& lo, const T& hi );	(1)	(C++17以上)
template<class T, class Compare> constexprconst T& clamp(const T& v, const T& lo, const T& hi, Compare comp );	(2)	(C++17以上)

1)v が lo より小さい場合は lo を返し、そうでなく hi が v より小さい場合は hi を返し、そうでなければ v を返します。 値を比較するために operator< を使用します。

2)(1) と同じですが、値を比較するために comp を使用します。

lo の値が hi より大きい場合、動作は未定義です。

引数

v	-	クランプする値
lo,hi	-	v をクランプする境界
comp	-	第1引数が第2引数より小さい場合に true を返す、比較関数オブジェクト (Compare の要件を満たすオブジェクト)。 比較関数のシグネチャは以下と同等であるべきです。  bool cmp(const Type1 &a, const Type2 &b); シグネチャが const& を持つ必要はありませんが、関数は渡されたオブジェクトを変更してはならず、値カテゴリに関わらず Type1 および Type2 型 (およびそれらの const 修飾された型) のすべての値を受理できなければなりません (そのため Type1 & は許されません。 また Type1 に対してムーブがコピーと同等でなければ Type1 も許されません(C++11以上))。 型 Type1 および Type2 は、どちらも T 型のオブジェクトから暗黙に変換可能なものでなければなりません。 ​
型の要件
- オーバロード (1) を使用するためには T は LessThanComparable の要件を満たさなければなりません。

戻り値

v が lo より小さい場合は lo を指す参照、 hi が v より小さい場合は hi を指す参照、そうでなければ v を指す参照。

計算量

多くとも2回の比較。

実装例

1つめのバージョン
template<class T>constexprconst T& clamp(const T& v, const T& lo, const T& hi ){return clamp( v, lo, hi, std::less<>());}
2つめのバージョン
template<class T, class Compare>constexprconst T& clamp(const T& v, const T& lo, const T& hi, Compare comp ){returnassert(!comp(hi, lo)), comp(v, lo)? lo : comp(hi, v)? hi : v;}

ノート

引数のいずれかが右辺値で、その引数が返された場合、 std::clamp の結果を参照でキャプチャすると、ダングリング参照が生成されます。

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

v がいずれかの境界と同等な場合は、境界でなく v を指す参照が返されます。

浮動小数点の T に対しては、 NaN が避けられる場合にのみ動作します。

例

Run this code

#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	指定された値の大きい方を返します (関数テンプレート)