std::ranges::remove, std::ranges::remove_if
| 定义于头文件 <algorithm> |
||
| 调用签名 (Call signature) |
||
| (1) | ||
template< std::permutable I, std::sentinel_for<I> S, class T, class Proj = std::identity > |
(C++20 起) （直到 C++26） |
|
| template< std::permutable I, std::sentinel_for<I> S, class Proj = std::identity, |
(C++26 起) | |
| (2) | ||
| template< ranges::forward_range R, class T, class Proj = std::identity > |
(C++20 起) （直到 C++26） |
|
| template< ranges::forward_range R, class Proj = std::identity, |
(C++26 起) | |
template< std::permutable I, std::sentinel_for<I> S, class Proj = std::identity, |
(3) | (C++20 起) |
| template< ranges::forward_range R, class Proj = std::identity, |
(4) | (C++20 起) |
从范围 [first, last) 中移除所有满足特定条件的元素，并返回一个子范围 [ret, last)，其中 ret 是该范围新末尾的过尾迭代器。
移除操作通过移动赋值来完成，将不需要移除的元素移动到范围的开头。保留剩余元素的相对顺序，容器的*物理*大小不变。指向新*逻辑*末尾和*物理*末尾之间元素的迭代器仍然可以解引用，但这些元素本身的值未指定（根据MoveAssignable的后置条件）。
本页描述的类函数实体是 算法函数对象（非正式地称为 niebloids），即
目录 |
[编辑] 参数
| first, last | - | 定义要处理元素的范围的迭代器-哨兵对 |
| r | - | 要处理的元素范围 |
| value | - | 要移除的元素值 |
| pred | - | 应用于投影元素的谓词 |
| proj | - | 应用于元素的投影 |
[编辑] 返回值
{ret, last}，其中 [first, ret) 是移除后的结果子范围，子范围 [ret, last) 中的所有元素都处于有效但未指定状态，即 [ret, last) 是要擦除的子范围。
[编辑] 复杂度
精确执行 N 次对应谓词和任何投影的操作，其中 N = ranges::distance(first, last)，并且最坏情况下执行 N - 1 次移动操作。
[编辑] 注解
调用 `ranges::remove` 后通常会调用容器的 `erase` 成员函数，该函数会擦除未指定的值并将容器的*物理*大小减小到与其新的*逻辑*大小匹配。这两个调用共同构成了所谓的擦除-移除习语，可以通过自由函数std::erase实现，该函数对所有标准*序列*容器都有重载，或者通过std::erase_if实现，该函数对*所有*标准容器都有重载。
名称相似的容器成员函数list::remove、list::remove_if、forward_list::remove和forward_list::remove_if会擦除被移除的元素。
这些算法通常不能用于关联容器，例如 std::set 和 std::map，因为它们的迭代器类型不能解引用为 MoveAssignable 类型（这些容器中的键不可修改）。
由于 ranges::remove 通过引用接收 value，如果它引用范围 [first, last) 中的某个元素，则可能会导致意外行为。
[编辑] 可能的实现
| remove (1,2) |
|---|
struct remove_fn { template<std::permutable I, std::sentinel_for<I> S, class Proj = std::identity, class T = std::projected_value_t<I, Proj>> requires std::indirect_binary_predicate <ranges::equal_to, std::projected<I, Proj>, const T*> constexpr ranges::subrange<I> operator()(I first, S last, const T& value, Proj proj = {}) const { first = ranges::find(std::move(first), last, value, proj); if (first != last) { for (I i{std::next(first)}; i != last; ++i) if (value != std::invoke(proj, *i)) { *first = ranges::iter_move(i); ++first; } } return {first, last}; } template<ranges::forward_range R, class Proj = std::identity, class T = std::projected_value_t<ranges::iterator_t<R>, Proj>> requires std::permutable<ranges::iterator_t<R>> && std::indirect_binary_predicate <ranges::equal_to, std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr ranges::borrowed_subrange_t<R> operator()(R&& r, const T& value, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), value, std::move(proj)); } }; inline constexpr remove_fn remove {}; |
| remove_if (3,4) |
struct remove_if_fn { template<std::permutable I, std::sentinel_for<I> S, class Proj = std::identity, std::indirect_unary_predicate<std::projected<I, Proj>> Pred> constexpr ranges::subrange<I> operator()(I first, S last, Pred pred, Proj proj = {}) const { first = ranges::find_if(std::move(first), last, pred, proj); if (first != last) { for (I i{std::next(first)}; i != last; ++i) if (!std::invoke(pred, std::invoke(proj, *i))) { *first = ranges::iter_move(i); ++first; } } return {first, last}; } template<ranges::forward_range R, class Proj = std::identity, std::indirect_unary_predicate <std::projected<ranges::iterator_t<R>, Proj>> Pred> requires std::permutable<ranges::iterator_t<R>> constexpr ranges::borrowed_subrange_t<R> operator()(R&& r, Pred pred, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), pred, std::move(proj)); } }; inline constexpr remove_if_fn remove_if {}; |
[编辑] 注解
| 特性测试宏 | 值 | 标准 | 特性 |
|---|---|---|---|
__cpp_lib_algorithm_default_value_type |
202403 |
(C++26) | 算法的列表初始化 (1,2) |
[编辑] 示例
#include <algorithm> #include <cassert> #include <complex> #include <cctype> #include <iomanip> #include <iostream> #include <string> #include <string_view> #include <vector> int main() { std::string v1{"No - Diagnostic - Required"}; std::cout << std::quoted(v1) << " (v1, size: " << v1.size() << ")\n"; const auto ret = std::ranges::remove(v1, ' '); std::cout << std::quoted(v1) << " (v1 after `remove`, size: " << v1.size() << ")\n"; std::cout << ' ' << std::string(std::distance(v1.begin(), ret.begin()), '^') << '\n'; v1.erase(ret.begin(), ret.end()); std::cout << std::quoted(v1) << " (v1 after `erase`, size: " << v1.size() << ")\n\n"; // remove_if with custom unary predicate: auto rm = [](char c) { return !std::isupper(c); }; std::string v2{"Substitution Failure Is Not An Error"}; std::cout << std::quoted(v2) << " (v2, size: " << v2.size() << ")\n"; const auto [first, last] = std::ranges::remove_if(v2, rm); std::cout << std::quoted(v2) << " (v2 after `remove_if`, size: " << v2.size() << ")\n"; std::cout << ' ' << std::string(std::distance(v2.begin(), first), '^') << '\n'; v2.erase(first, last); std::cout << std::quoted(v2) << " (v2 after `erase`, size: " << v2.size() << ")\n\n"; // creating a view into a container that is modified by `remove_if`: for (std::string s : {"Small Object Optimization", "Non-Type Template Parameter"}) std::cout << std::quoted(s) << " => " << std::string_view{begin(s), std::ranges::remove_if(s, rm).begin()} << '\n'; std::vector<std::complex<double>> nums{{2, 2}, {1, 3}, {4, 8}}; #ifdef __cpp_lib_algorithm_default_value_type auto e = std::ranges::remove(nums, {1, 3}); // T gets deduced #else auto e = std::ranges::remove(nums, std::complex<double>{1, 3}); #endif nums.erase(e.begin(), e.end()); assert((nums == std::vector<std::complex<double>>{{2, 2}, {4, 8}})); }
可能的输出
"No _ Diagnostic _ Required" (v1, size: 26) "No_Diagnostic_Requiredired" (v1 after `remove`, size: 26) ^^^^^^^^^^^^^^^^^^^^^^ "No_Diagnostic_Required" (v1 after `erase`, size: 22) "Substitution Failure Is Not An Error" (v2, size: 36) "SFINAEtution Failure Is Not An Error" (v2 after `remove_if`, size: 36) ^^^^^^ "SFINAE" (v2 after `erase`, size: 6) "Small Object Optimization" => SOO "Non-Type Template Parameter" => NTTP
[编辑] 参阅
| (C++20)(C++20) |
复制一个范围的元素，忽略那些满足特定条件的元素 (算法函数对象) |
| (C++20) |
移除一个范围中的连续重复元素 (算法函数对象) |
| 移除满足特定标准的元素 (函数模板) |
