std::remove, std::remove_if
在标头 <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, |
(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, |
(C++20 起) | |
template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate > ForwardIt remove_if( ExecutionPolicy&& policy, |
(4) | (C++17 起) |
从范围 [first, last)
移除所有满足特定判别标准的元素,并返回范围新结尾的尾后迭代器。
operator==
比较)value 的元素。
std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> |
(C++20 前) |
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> |
(C++20 起) |
如果 |
(C++11 前) |
如果 *first 的类型不 可移动赋值 (MoveAssignable) ,那么行为未定义。 |
(C++11 起) |
通过使未被移除的元素出现在范围起始这种方式,迁移(方式为复制赋值 (C++11 前)移动赋值 (C++11 起))范围中元素,来进行移除。保持剩余元素的相对顺序而容器的物理大小保持不变。指向新的逻辑结尾与物理结尾之间的迭代器仍然可解引用,但元素自身拥有未指定的值(经由可移动赋值 (MoveAssignable) 的后条件 (C++11 起))。
参数
first, last | - | 要处理的元素范围 |
value | - | 要移除的元素值 |
policy | - | 所用的执行策略。细节见执行策略。 |
p | - | 如果应该移除元素则返回 true 的一元谓词。 对每个(可为 const 的) |
类型要求 | ||
-ForwardIt 必须符合老式向前迭代器 (LegacyForwardIterator) 的要求。
| ||
-解引用 ForwardIt 结果的类型必须满足可移动赋值 (MoveAssignable) 的要求。
| ||
-UnaryPredicate 必须符合谓词 (Predicate) 的要求。
|
返回值
新范围的尾后迭代器(如果它不是 end,那么它指向未指定值,而此迭代器与 end 之间的迭代器所指向的任何值也是这样)。
复杂度
给定 N
为 std::distance(first, last):
N
次 operator==
与 value 进行比较N
次谓词 p异常
拥有名为 ExecutionPolicy
的模板形参的重载按下列方式报告错误:
- 如果作为算法一部分调用的函数的执行抛出异常,且
ExecutionPolicy
是标准策略之一,那么调用 std::terminate。对于任何其他ExecutionPolicy
,行为由实现定义。 - 如果算法无法分配内存,那么抛出 std::bad_alloc。
注解
调用 std::remove
常后随容器的 erase
成员函数,它擦除未指定值并减小容器的物理大小以匹配其新的逻辑大小。这两个调用一并被称为擦除-移除手法,它可通过对所有标准序列容器重载的 std::erase 自由函数,或对所有标准容器重载的 std::erase_if 自由函数达成 (C++20 起)。
同名的容器成员函数 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)
中的元素,那么它可能有预期外的行为。
可能的实现
remove |
---|
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; } |
remove_if |
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; } |
示例
下列代码从字符串移除所有空格,通过迁移所有非空格字符到左侧,再擦除其他内容。这是擦除移除手法的样例。
#include <algorithm> #include <string> #include <iostream> #include <cctype> int main() { std::string str1 = "Text with some spaces"; auto noSpaceEnd = std::remove(str1.begin(), str1.end(), ' '); // 空格只是逻辑上从字符串被移除。 // 通过视图可以发现原始字符串并没有缩小: std::cout << std::string_view(str1.begin(), noSpaceEnd) << " 大小:" << str1.size() << '\n'; str1.erase(noSpaceEnd, str1.end()); // 物理移除字符串中的空格。 std::cout << str1 << " 大小:" << 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'; }
输出:
Textwithsomespaces 大小:23 Textwithsomespaces 大小:18 Textwithsomewhitespaces
缺陷报告
下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。
缺陷报告 | 应用于 | 出版时的行为 | 正确行为 |
---|---|---|---|
LWG 283 | C++98 | T 需要是 可相等比较 (EqualityComparable) 的,但是 ForwardIt 的值类型不一定是 T
|
改成要求 ForwardIt 的值类型是可复制赋值 (CopyAssignable) 的 |
参阅
复制一个范围的元素,忽略满足特定判别标准的元素 (函数模板) | |
移除范围内的连续重复元素 (函数模板) | |
(C++20)(C++20) |
移除满足特定判别标准的元素 (niebloid) |