命名空间
变体
操作

std::remove, std::remove_if

来自 cppreference.cn
< 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 );
(constexpr since C++20)
(until C++26)
template< class ForwardIt, class T = typename std::iterator_traits

                                         <ForwardIt>::value_type >
constexpr ForwardIt remove( ForwardIt first, ForwardIt last,

                            const T& value );
(since C++26)
(2)
template< class ExecutionPolicy, class ForwardIt, class T >

ForwardIt remove( ExecutionPolicy&& policy,

                  ForwardIt first, ForwardIt last, const T& value );
(since C++17)
(until 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 );
(since C++26)
template< class ForwardIt, class UnaryPred >
ForwardIt remove_if( ForwardIt first, ForwardIt last, UnaryPred p );
(3) (constexpr since C++20)
template< class ExecutionPolicy, class ForwardIt, class UnaryPred >

ForwardIt remove_if( ExecutionPolicy&& policy,

                     ForwardIt first, ForwardIt last, UnaryPred p );
(4) (since C++17)

从范围 [firstlast) 移除所有满足特定标准的元素,并为范围的新末尾返回一个past-the-end迭代器。

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) 中的每个元素都具有有效但未指定的状态,因为移动赋值可以通过从最初在该范围内的元素移动来消除元素。
(C++11 起)

[编辑] 参数

first, last - 定义要处理的元素的范围的迭代器对
value - 要移除的元素的值
policy - 要使用的执行策略
p - 一元谓词,如果元素应被移除,则返回 ​true

对于类型为 (可能为 const) VT 的每个参数 v,表达式 p(v) 必须可转换为 bool,其中 VTForwardIt 的值类型,无论值类别如何,并且不得修改 v。因此,不允许使用 VT& 的参数类型,除非对于 VT 移动等价于复制,否则也不允许使用 VT(C++11 起)。 ​

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

[编辑] 返回值

值的新范围的 past-the-end 迭代器 (如果这不是 end,则它指向未指定的值,并且此迭代器和 end 之间的任何值的迭代器也是如此)。

[编辑] 复杂度

给定 Nstd::distance(first, last)

1,2) 精确地 N 次使用 operator== 的比较。
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::remove, list::remove_if, forward_list::remove, 和 forward_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 <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

[编辑] 参见

复制一个元素范围,省略满足特定标准的元素
(函数模板) [编辑]
移除范围中连续的重复元素
(函数模板) [编辑]
移除满足特定标准的元素
(算法函数对象)[编辑]