std::remove, std::remove_if

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
未初始化存储上的操作
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
(C++11)
(C++17)

排列
数值运算
C 库
 
定义于头文件 <algorithm>
(1)
template< class ForwardIt, class T >
ForwardIt remove( ForwardIt first, ForwardIt last, const T& value );
(C++20 前)
template< class ForwardIt, class T >
constexpr ForwardIt remove( ForwardIt first, ForwardIt last, const T& value );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt, class T >

ForwardIt remove( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last,

                  const T& value );
(2) (C++17 起)
(3)
template< class ForwardIt, class UnaryPredicate >
ForwardIt remove_if( ForwardIt first, ForwardIt last, UnaryPredicate p );
(C++20 前)
template< class ForwardIt, class UnaryPredicate >
constexpr ForwardIt remove_if( ForwardIt first, ForwardIt last, UnaryPredicate p );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate >

ForwardIt remove_if( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last,

                     UnaryPredicate p );
(4) (C++17 起)

从范围 [first, last) 移除所有满足特定判别标准的元素,并返回范围新结尾的尾后迭代器。

1) 移除所有等于 value 的元素,用 operator== 比较它们。
3) 移除所有 p 对于它返回 true 的元素。
2,4)(1,3) ,但按照 policy 执行。这些重载仅若 std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> (C++20 前)std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> (C++20 起) 为 true 才参与重载决议。

通过使未被移除的元素出现在范围起始这种方式,迁移(方式为复制赋值 (C++11 前)移动赋值 (C++11 起))范围中元素,来进行移除。保持剩余元素的相对顺序而容器的物理大小保持不变。指向新的逻辑结尾与物理结尾之间的迭代器仍然可解引用,但元素自身拥有未指定的值(经由可移动赋值 (MoveAssignable) 的后条件)。

参数

first, last - 要处理的元素范围
value - 要移除的元素值
policy - 所用的执行策略。细节见执行策略
p - 若应该移除元素则返回 ​true 的一元谓词。

对每个(可为 const 的) VT 类型参数 v ,其中 VTForwardIt 的值类型,表达式 p(v) 必须可转换为 bool ,无关乎值类别,而且必须不修改 v 。从而不允许 VT& 类型参数,亦不允许 VT ,除非对 VT 而言移动等价于复制 (C++11 起)。 ​

类型要求
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator) 的要求。
-
解引用 ForwardIt 结果的类型必须满足可移动赋值 (MoveAssignable) 的要求。
-
UnaryPredicate 必须满足谓词 (Predicate) 的要求。

返回值

新值范围的尾后迭代器(若它不是 end ,则它指向未指定值,而此迭代器与 end 之间的迭代器所指向的任何值亦然)。

复杂度

准确应用 std::distance(first, last) 次谓词。

异常

拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误:

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

注解

调用 std::remove 常后随容器的 erase 成员函数,它擦除未指定值并减小容器的物理大小以匹配其新的逻辑大小。这两个调用一并被称为擦除-移除手法,它可通过对所有标准序列容器重载的 std::erase 自由函数,或对所有标准容器重载的 std::erase_if 自由函数达成 (C++20 起)

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

这些算法通常不能用于如 std::setstd::map 的关联容器,因为其迭代器类型不解引用为可移动赋值 (MoveAssignable) 类型(这些容器中的键不可修改)。

标准库亦于 <cstdio> 定义 std::remove 的重载,它接收 const char* 的重载并用于删除文件。

因为 std::remove 以引用接收 value ,若引用到范围 [first, last) 中的元素,则它可能有不可预期的行为。

可能的实现

版本一
template< class ForwardIt, class T >
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 UnaryPredicate>
ForwardIt remove_if(ForwardIt first, ForwardIt last, UnaryPredicate 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;
}

示例

下列代码从 string 移除所有空格,通过迁移所有非空格字符到左侧,再擦除其他内容。这是擦除移除手法的样例。

#include <algorithm>
#include <string>
#include <iostream>
#include <cctype>
 
int main()
{
    std::string str1 = "Text with some   spaces";
    str1.erase(std::remove(str1.begin(), str1.end(), ' '),
               str1.end());
    std::cout << str1 << '\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';
}

输出:

Textwithsomespaces
Textwithsomewhitespaces

参阅

复制一个范围的元素,忽略满足特定判别标准的元素
(函数模板)
移除范围内的连续重复元素
(函数模板)
移除满足特定判别标准的元素
(niebloid)