std::remove, std::remove_if

 

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)

 

ヘッダー <algorithm> で定義
	(1)
template< class ForwardIt, class T > ForwardIt remove( ForwardIt first, ForwardIt last, const T& value );			(C++20 以降 constexpr) (C++26まで)
template< class ForwardIt, class T = typename std::iterator_traits                                          <ForwardIt>::value_type > constexpr ForwardIt remove( ForwardIt first, ForwardIt last,                             const T& value );			(C++26以降)
		(2)
template< class ExecutionPolicy, class ForwardIt, class T > ForwardIt remove( ExecutionPolicy&& policy,                   ForwardIt first, ForwardIt last, const T& value );				(C++17以降) (C++26まで)
template< class ExecutionPolicy, class ForwardIt,           class T = typename std::iterator_traits                         <ForwardIt>::value_type > ForwardIt remove( ExecutionPolicy&& policy,                   ForwardIt first, ForwardIt last, const T& value );				(C++26以降)
template< class ForwardIt, class UnaryPred > ForwardIt remove_if( ForwardIt first, ForwardIt last, UnaryPred p );			(3)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt, class UnaryPred > ForwardIt remove_if( ExecutionPolicy&& policy,                      ForwardIt first, ForwardIt last, UnaryPred p );			(4)	(C++17以降)

指定された条件を満たす要素を範囲 [first, last) から削除し、範囲の新しい終端を示すイテレータを返します。

1) value と等しいすべての要素を削除します（operator== を使用）。

3) 述語 p が true を返すすべての要素を削除します。

2,4) (1,3)と同じだが、policyに従って実行される。

これらのオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加する。

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である。	(C++20まで)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> は true です。	(C++20以降)

ForwardIt の値の型が CopyAssignable でない場合、動作は未定義です。	(C++11まで)
*first の型が MoveAssignable でない場合、動作は未定義です。	(C++11以降)

説明

削除は、削除されない要素が範囲の先頭に現れるように、範囲内の要素をシフトすることによって行われます。

• シフトは コピー代入(C++11 まで)ムーブ代入(C++11 以降) によって行われます。
• 削除操作は安定です。削除されない要素の相対順序は変更されません。
• [first, last) の基となるシーケンスは、削除操作によって短縮されません。返されるイテレータを result とすると

• [result, last) のすべてのイテレータは、依然として デリファレンス可能です。

[result, last) の各要素は、有効だが未指定の状態を持ちます。これは、ムーブ代入がその範囲内の元の要素から移動することによって要素を削除できるためです。

(C++11以降)

パラメータ

first, last	-	処理する要素の 範囲 を定義するイテレータのペア
value	-	削除する要素の値
policy	-	使用する 実行ポリシー
p	-	要素を削除すべき場合に ​true を返す単項述語。 ForwardIt の値の型 VT（おそらく const）のすべての引数 v に対して、p(v) は bool に変換可能であり、値カテゴリに関係なく v を変更しない必要があります。したがって、VT& というパラメータ型は許可されません。また、VT がムーブがコピーと同等である場合を除き、VT も同様です(C++11 以降)。
型要件
- ForwardIt は LegacyForwardIterator の要件を満たさなければなりません。
- UnaryPredicate は Predicate の要件を満たさなければなりません。

戻り値

新しい値の範囲を示す終端イテレータ（これが end でない場合、未指定の値を示し、このイテレータと end の間の値に対するイテレータも同様です）。

計算量

std::distance(first, last) を \(\scriptsize N\)N とする

1,2) \(\scriptsize N\)N 回の operator== による比較。

3,4) 述語 p の \(\scriptsize N\)N 回の適用。

例外

ExecutionPolicy というテンプレートパラメータを持つオーバーロードは、次のようにエラーを報告します。

• アルゴリズムの一部として呼び出された関数の実行が例外をスローし、ExecutionPolicy が 標準ポリシー のいずれかである場合、std::terminate が呼び出されます。その他の ExecutionPolicy の場合、動作は実装定義です。
• アルゴリズムがメモリの割り当てに失敗した場合、std::bad_alloc がスローされます。

実装例

remove (1)
template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type> ForwardIt remove(ForwardIt first, ForwardIt last, const T& value) { first = std::find(first, last, value); if (first != last) for (ForwardIt i = first; ++i != last;) if (!(*i == value)) *first++ = std::move(*i); return first; }
remove_if (3)
template<class ForwardIt, class UnaryPred> ForwardIt remove_if(ForwardIt first, ForwardIt last, UnaryPred p) { first = std::find_if(first, last, p); if (first != last) for (ForwardIt i = first; ++i != last;) if (!p(*i)) *first++ = std::move(*i); return first; }

注記

remove の呼び出しの後には、通常、コンテナから要素を実際に削除するためのコンテナの erase メンバ関数の呼び出しが続きます。この 2 つの呼び出しを組み合わせたものが、いわゆる erase-remove イディオムです。

同様の効果は、次の非メンバ関数でも達成できます。 std::erase。これは、すべての標準シーケンスコンテナに対する オーバーロード を持ちます。 std::erase_if。これは、すべての標準コンテナに対する オーバーロード を持ちます。

(C++20以降)

同様の名前を持つコンテナの メンバ関数である list::remove、list::remove_if、forward_list::remove、および forward_list::remove_if は、削除された要素を削除します。

これらのアルゴリズムは、std::set や std::map のような連想コンテナには使用できません。これは、これらのコンテナのイテレータ型が MoveAssignable 型をデリファレンスしないためです（これらのコンテナのキーは変更できません）。

標準ライブラリは、<cstdio> に std::remove のオーバーロードも定義しています。これは const char* を取り、ファイルの削除に使用されます。

std::remove は value を参照で受け取るため、それが範囲 [first, last) の要素への参照である場合、予期しない動作を引き起こす可能性があります。

機能テストマクロ	値	規格	機能
__cpp_lib_algorithm_default_value_type	202403	(C++26)	アルゴリズム (1,2) のためのリスト初期化

例

次のコードは、文字列からすべてのスペースを削除します。これは、スペース以外のすべての文字を左にシフトしてから、余分な文字を削除することによって行われます。これは erase-remove イディオムの例です。

このコードを実行

#include <algorithm>
#include <cassert>
#include <cctype>
#include <complex>
#include <iomanip>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>
 
int main()
{
    std::string str1{"Quick  Red  Dog"};
    std::cout << "1) " << std::quoted(str1) << '\n';
    const auto noSpaceEnd = std::remove(str1.begin(), str1.end(), ' ');
    std::cout << "2) " << std::quoted(str1) << '\n';
 
    // The spaces are removed from the string only logically.
    // Note, we use view, the original string is still not shrunk:
    std::cout << "3) " << std::quoted(std::string_view(str1.begin(), noSpaceEnd))
              << ", size: " << str1.size() << '\n';
 
    str1.erase(noSpaceEnd, str1.end());
    // The spaces are removed from the string physically.
    std::cout << "4) " << std::quoted(str1) << ", size: " << str1.size() << '\n';
 
    std::string str2 = "Jumped\n Over\tA\vLazy \t  Fox\r\n";
    str2.erase(std::remove_if(str2.begin(), 
                              str2.end(),
                              [](unsigned char x) { return std::isspace(x); }),
               str2.end());
    std::cout << "5) " << std::quoted(str2) << '\n';
 
    std::vector<std::complex<double>> nums{{2, 2}, {1, 3}, {4, 8}};
    #ifdef __cpp_lib_algorithm_default_value_type
        nums.erase(std::remove(nums.begin(), nums.end(), {1, 3}), nums.end());
    #else
        nums.erase(std::remove(nums.begin(), nums.end(), std::complex<double>{1, 3}),
                   nums.end());
    #endif
    assert((nums == std::vector<std::complex<double>>{{2, 2}, {4, 8}}));
}

出力

1) "Quick  Red  Dog"
2) "QuickRedDog Dog"
3) "QuickRedDog", size: 15
4) "QuickRedDog", size: 11
5) "JumpedOverALazyFox"

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 283	C++98	T は EqualityComparable であることが求められていましたが、 ForwardIt の値の型は常に T ではない	ForwardIt の値の型が 代わりに CopyAssignable である必要がある

関連項目

remove_copyremove_copy_if	特定の基準を満たす要素を除外して範囲をコピーする (関数テンプレート)
unique	範囲内の連続する重複要素を削除する (関数テンプレート)
ranges::removeranges::remove_if (C++20)(C++20)	特定の基準を満たす要素を削除する (アルゴリズム関数オブジェクト)