命名空间
变体
操作

std::ranges::remove,std::ranges::remove_if

来自 cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
算法库
约束算法和范围上的算法 (C++20)
约束算法,例如 ranges::copyranges::sort,...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在分区范围上)
集合操作(在排序范围内)
合并操作(在排序范围内)
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
对未初始化内存的操作
 
约束算法
此菜单中的所有名称都属于 std::ranges 命名空间
非修改序列操作
修改序列操作
分区操作
排序操作
二分搜索操作(在排序范围内)
       
       
集合操作(在排序范围内)
堆操作
最小/最大操作
       
       
排列操作
折叠操作
数值操作
(C++23)            
对未初始化存储的操作
返回类型
 
定义在头文件中 <algorithm>
调用签名
(1)
template< std::permutable I, std::sentinel_for<I> S,

          class T, class Proj = std::identity >
requires std::indirect_binary_predicate
             <ranges::equal_to, std::projected<I, Proj>, const T*>
constexpr ranges::subrange<I>

    remove( I first, S last, const T& value, Proj proj = {} );
(自 C++20 起)
(直到 C++26)
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>

    remove( I first, S last, const T& value, Proj proj = {} );
(自 C++26 起)
(2)
template< ranges::forward_range R,

          class T, class Proj = std::identity >
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>

    remove( R&& r, const T& value, Proj proj = {} );
(自 C++20 起)
(直到 C++26)
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>

    remove( R&& r, const T& value, Proj proj = {} );
(自 C++26 起)
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>

    remove_if( I first, S last, Pred pred, Proj proj = {} );
(3) (自 C++20 起)
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>

    remove_if( R&& r, Pred pred, Proj proj = {} );
(4) (自 C++20 起)

从范围 [firstlast) 中删除所有满足特定条件的元素,并返回一个子范围 [retlast),其中 ret 是该范围新结尾的过去结尾迭代器。

1) 删除所有等于 value 的元素,使用 std::invoke(proj, *i) == value 进行比较。
3) 删除所有 std::invoke(pred, std::invoke(proj, *i)) 返回 true 的元素。
2,4)(1,3) 相同,但使用 r 作为范围,如同使用 ranges::begin(r) 作为 firstranges::end(r) 作为 last

删除是通过移动范围中的元素来完成的(通过移动赋值),这样,不应删除的元素会出现在范围的开头。保留了剩余元素的相对顺序,容器的物理大小保持不变。指向新逻辑结尾和物理结尾之间元素的迭代器仍然可解引用,但元素本身的值未指定(根据 MoveAssignable 后置条件)。

此页面上描述的函数式实体是niebloids,也就是说

在实践中,它们可以作为函数对象实现,或者使用特殊的编译器扩展。

内容

[edit] 参数

first, last - 要处理的元素范围
r - 要处理的元素范围
value - 要删除的元素的值
pred - 要应用于投影元素的谓词
proj - 要应用于元素的投影

[edit] 返回值

{ret, last},其中 [firstret) 是删除后得到的子范围,子范围 [retlast) 中的所有元素都处于有效但未指定的狀態,即 [retlast) 是要擦除的子范围。

[edit] 复杂度

正好 N 次对应谓词的应用以及任何投影,其中 N = ranges::distance(first, last),最坏情况下有 N - 1 次移动操作。

[edit] 注释

通常,ranges::remove 的调用后面跟着容器的 erase 成员函数的调用,该函数会擦除未指定的值,并将容器的物理大小减少到与其新的逻辑大小匹配。这两个调用一起构成了所谓的 擦除-删除习语,可以通过自由函数 std::erase 实现,该函数对所有标准序列容器都具有 重载,或者通过 std::erase_if 实现,该函数对所有标准容器都具有 重载

类似命名的容器 成员函数 list::removelist::remove_ifforward_list::removeforward_list::remove_if 会擦除被删除的元素。

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

因为 ranges::remove 按引用传递 value,所以如果它是一个对范围 [firstlast) 中元素的引用,则可能会出现意外的行为。

[edit] 可能的实现

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

[edit] 注释

功能测试 Std 功能
__cpp_lib_algorithm_default_value_type 202403 (C++26) 算法的 列表初始化 (1,2)

[edit] 示例

#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

[edit] 另请参见

复制一个元素范围,省略满足特定条件的元素
(niebloid)[edit]
删除一个范围中连续的重复元素
(niebloid)[edit]
删除满足特定条件的元素
(函数模板) [edit]