std::ranges::clamp

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

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

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (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> で定義
呼び出しシグネチャ
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 より大きい場合、動作は未定義です。

このページで説明されている関数のようなエンティティは、アルゴリズム関数オブジェクト（非公式にはニーブロイドとして知られている）です。つまり、

• これらのいずれかを呼び出す際に、明示的なテンプレート引数リストを指定することはできません。
• これらのいずれも実引数依存の名前探索には見えません。
• これらのいずれかが関数呼び出し演算子の左側の名前として通常の非修飾名探索によって見つかった場合、実引数依存の名前探索は抑制されます。

パラメータ

v	-	クランプする値
lo, hi	-	v をクランプする境界
comp	-	投影された要素に適用する比較
proj	-	v、lo、および hi に適用する投影

戻り値

投影された v の値が投影された lo の値より小さい場合は lo への参照、投影された hi の値が投影された v の値より小さい場合は hi への参照、それ以外の場合は v への参照。

計算量

最大2回の比較と3回の投影の適用。

実装例

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 の場合、コンパイラは2回キャッシュしてムーブする必要があり、コンパイラへの2回の呼び出しが発生します。

• libstdc++ はこれに準拠しておらず、常に投影結果を lvalue として渡します。
• libc++ は以前、投影を2回実行していましたが、Clang 18 で修正されました。
• MSVC STL は以前、投影を2回実行していましたが、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)	値を一対の境界値の間に制限する (関数テンプレート)