命名空间
变体
操作

std::remove, std::remove_if

来自 cppreference.cn
< cpp‎ | 算法
 
 
算法库
有约束算法与针对范围的算法 (C++20)
有约束的算法,例如 ranges::copyranges::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` 的值类型不是可复制赋值,则行为未定义。

(C++11 前)

如果 *first 的类型不是可移动赋值,则行为未定义。

(C++11 起)

目录

[edit] 说明

移除操作通过移动范围中的元素来完成,使得不被移除的元素出现在范围的开头。

  • 移动通过复制赋值(C++11 前)移动赋值(C++11 起)完成。
  • 移除操作是稳定的:不被移除的元素的相对顺序保持不变。
  • 通过移除操作,[firstlast) 的底层序列不会缩短。给定返回的迭代器为 result
  • [resultlast) 的每个元素都具有有效但未指定的状态,因为移动赋值可以通过从原本在该范围内的元素中移动来消除元素。
(C++11 起)

[edit] 参数

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

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

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

[edit] 返回值

新值范围的尾后迭代器(如果这不是 end,则它指向一个未指定的值,此迭代器与 end 之间的任何迭代器也如此)。

[edit] 复杂度

给定 Nstd::distance(first, last)

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

[edit] 异常

带有模板参数 ExecutionPolicy 的重载按如下方式报告错误

  • 如果作为算法一部分调用的函数执行时抛出异常,并且 `ExecutionPolicy` 是标准策略之一,则调用 std::terminate。对于任何其他 `ExecutionPolicy`,行为由实现定义。
  • 如果算法未能分配内存,则抛出 std::bad_alloc

[edit] 可能的实现

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

[edit] 注意

对 `remove` 的调用通常后跟对容器的 `erase` 成员函数的调用,以实际从容器中移除元素。这两个调用共同构成了所谓的擦除-移除习语

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

(C++20 起)

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

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

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

由于 `std::remove` 通过引用获取 value,如果它是对范围 [firstlast) 中元素的引用,则可能出现意外行为。

特性测试 标准 特性
__cpp_lib_algorithm_default_value_type 202403 (C++26) 算法的列表初始化 (1,2)

[edit] 示例

以下代码通过将所有非空格字符左移,然后擦除多余的字符来删除字符串中的所有空格。这是擦除-移除习语的一个示例。

#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"

[edit] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 283 C++98 要求 TEqualityComparable,但
`ForwardIt` 的值类型并非总是 `T`
要求 `ForwardIt` 的值类型
可复制赋值

[edit] 参阅

复制一个范围的元素,忽略那些满足特定条件的元素
(函数模板) [edit]
移除一个范围中的连续重复元素
(函数模板) [edit]
移除满足特定标准的元素
(算法函数对象)[edit]