std::remove, std::remove_if

template< class ForwardIt, class T >
ForwardIt remove( ForwardIt first, ForwardIt last, const T& value );

template< class ForwardIt, class T = typename std::iterator_traits
                                         <ForwardIt>::value_type >
constexpr ForwardIt remove( ForwardIt first, ForwardIt last,
                            const T& value );

template< class ExecutionPolicy, class ForwardIt, class T >
ForwardIt remove( ExecutionPolicy&& policy,
                  ForwardIt first, ForwardIt last, const T& value );

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 );

template< class ForwardIt, class UnaryPred >
ForwardIt remove_if( ForwardIt first, ForwardIt last, UnaryPred p );

template< class ExecutionPolicy, class ForwardIt, class UnaryPred >
ForwardIt remove_if( ExecutionPolicy&& policy,
                     ForwardIt first, ForwardIt last, UnaryPred p );

範囲 [first, last) から特定の条件を満たすすべての要素を削除し、範囲の新しい終端を指すオーバーエンドイテレータを返します。

説明

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

• シフト操作は copy assignment (until C++11) move assignment (since C++11) によって行われます。
• 削除操作は安定しています：削除されない要素の相対的な順序は維持されます。
• [ first , last ) の基となるシーケンスは削除操作によって短縮されません。返されるイテレータを result として：

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

パラメータ

戻り値

新しい値の範囲の末尾後ろイテレータ（これが end でない場合、これは未規定の値を指し、このイテレータと end の間の任意の値に対するイテレータも同様です）。

計算量

与えられた \(\scriptsize N\) N を std:: distance ( first, last ) として：

例外

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

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

実装例

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;
}

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イディオム を構成します。

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

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

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

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

例

#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++規格に対して遡及的に適用されました。

関連項目