命名空间
变体
操作

std::remove, std::remove_if

来自 cppreference.com
< cpp‎ | algorithm
 
 
算法库
约束算法和范围上的算法 (C++20)
约束算法,例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在分区范围内)
集合操作(在排序范围内)
合并操作(在排序范围内)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
对未初始化内存的操作
 
定义在头文件 <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 起)

从范围 [firstlast) 中删除所有满足特定条件的元素,并返回该范围的新末尾的超出末尾的迭代器。

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 开始) 完成的。
  • 移除操作是稳定的:要保留的元素的相对顺序保持不变。
  • [firstlast) 的基础序列不会因移除操作而缩短。假设返回的迭代器为 result
  • [resultlast) 中的所有迭代器仍然是 可解引用 的。
  • [resultlast) 的每个元素都有一个有效的但未指定的狀態,因为赋值移动可以通過从最初在这个范围内的元素进行移动来消除元素。
(自 C++11 起)

[编辑] 参数

first, last - 要处理的元素范围
value - 要移除的元素的值
policy - 要使用的执行策略。有关详细信息,请参见 执行策略
p - 一元谓词,如果元素应该被移除则返回 ​true

表达式 p(v) 必须可转换为 bool,适用于类型为 (可能为 const) VT 的每个参数 v,其中 VTForwardIt 的值类型,而与 值类别 无关,并且不得修改 v。因此,不允许使用 VT& 作为参数类型,也不允许使用 VT,除非 VT 的移动等效于复制(从 C++11 开始)。​

类型要求
-
ForwardIt 必须满足 LegacyForwardIterator 的要求。
-
UnaryPredicate 必须满足 Predicate 的要求。

[编辑] 返回值

新值范围的尾后迭代器(如果这并非 end,那么它指向一个未指定的元素,并且指向此迭代器和 end 之间任何元素的迭代器也是如此)。

[编辑] 复杂度

假设 Nstd::distance(first, last)

1,2) 使用 operator== 进行精确的 N 次比较。
3,4) 精确的 N 次谓词 p 应用。

[编辑] 异常

具有名为 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 成员函数的调用,以真正从容器中移除元素。这两个调用一起构成了所谓的 Erase-remove 惯用法

相同的效果也可以通过以下非成员函数来实现

(自 C++20 起)

类似命名的容器 成员函数 list::removelist::remove_ifforward_list::removeforward_list::remove_if 会擦除被移除的元素。

这些算法不能与关联容器(例如 std::setstd::map)一起使用,因为它们的迭代器类型不会解引用到 MoveAssignable 类型(这些容器中的键不可修改)。

标准库还在 <cstdio> 中定义了 std::remove 的重载,它接受一个 const char* 并用于删除文件。

因为 std::remove 按引用接受 value,所以如果它是一个指向范围 [firstlast) 中的元素的引用,那么它可能会出现意外行为。

功能测试 Std 功能
__cpp_lib_algorithm_default_value_type 202403 (C++26) 算法的 列表初始化 (1,2)

[编辑] 示例

以下代码通过将所有非空格字符左移,然后擦除多余的字符,从字符串中移除所有空格。这是一个 Erase-remove 惯用法 的示例。

#include <algorithm>
#include <cassert>
#include <cctype>
#include <complex>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>
 
int main()
{
    std::string str1{"Text with some   spaces"};
 
    auto noSpaceEnd = std::remove(str1.begin(), str1.end(), ' ');
 
    // The spaces are removed from the string only logically.
    // Note, we use view, the original string is still not shrunk:
    std::cout << 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 << str1 << " size: " << str1.size() << '\n';
 
    std::string str2 = "Text\n with\tsome \t  whitespaces\n\n";
    str2.erase(std::remove_if(str2.begin(), 
                              str2.end(),
                              [](unsigned char x) { return std::isspace(x); }),
               str2.end());
    std::cout << 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}}));
}

输出

Textwithsomespaces size: 23
Textwithsomespaces size: 18
Textwithsomewhitespaces

[编辑] 缺陷报告

以下行为更改缺陷报告已追溯应用于以前发布的 C++ 标准。

DR 应用于 已发布的行为 正确的行为
LWG 283 C++98 T 需要是 EqualityComparable,但是
ForwardIt 的值类型并不总是 T
要求 ForwardIt 的值类型
CopyAssignable 而不是

[编辑] 另请参见

复制一个元素范围,省略满足特定条件的元素
(函数模板) [编辑]
移除范围内的连续重复元素
(函数模板) [编辑]
移除满足特定条件的元素
(niebloid)[编辑]