std::ranges::remove, std::ranges::remove_if
| 在标头 <algorithm> 定义
|
||
| 调用签名 |
||
| (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) 的后条件）。
此页面上描述的函数式实体是 niebloid，即：
实践中，可以作为函数对象，或者用某些特殊编译器扩展实现它们。
参数
| 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 |
|---|
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 |
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: 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"; // 创建到 `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 被推导 #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) |
复制一个范围的元素，忽略满足特定判别标准的元素 (niebloid) |
| (C++20) |
移除范围中的连续重复元素 (niebloid) |
| 移除满足特定判别标准的元素 (函数模板) |