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)，并返回指向新范围末尾的尾后迭代器。

说明

移除操作通过移动范围内的元素来实现，使得不需要被移除的元素出现在范围的起始位置。

• 移位操作通过 复制赋值 (C++11 前) 移动赋值 (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 成员函数的调用，以实际从容器中移除元素。这两个调用共同构成了所谓的 erase-remove idiom 。

同名的容器 成员函数 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 ) 内的元素，可能导致预期外的行为。

示例

#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';
    // 空格仅从逻辑上从字符串中移除
    // 注意：我们使用视图，原始字符串实际尚未收缩：
    std::cout << "3) " << std::quoted(std::string_view(str1.begin(), noSpaceEnd))
              << ", size: " << str1.size() << '\n';
    str1.erase(noSpaceEnd, str1.end());
    // 空格已从物理上从字符串中移除
    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++标准。

参见