std::remove,std::remove_if(3)

📦 version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

💖 `std::remove,std::remove_if(3)` 💖

okay so this is the std::remove,std::remove_if(3) page from the C++ Standard Libary manual, and it’s lowkey one of the most useful algorithm pages you’ll ever meet. It’s giving “I shift your elements around and hand you a new end iterator” energy. Let’s get into it, bestie 🫶.

🌸 NAME 🌸

std::remove, std::remove_if — yes, the name is literally std::remove,std::remove_if, and that’s the whole vibe. Cute, concise, iconic.

✨ Synopsis ✨

Defined in header <algorithm>

(1)
template< class ForwardIt, class T >
ForwardIt remove( ForwardIt first, ForwardIt last, const T& value );
(constexpr since C++20)
(until C++26)

(1)
template< class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type >
constexpr ForwardIt remove( ForwardIt first, ForwardIt last, const T& value );
(since C++26)

(2)
template< class ExecutionPolicy, class ForwardIt, class T >
ForwardIt remove( ExecutionPolicy&& policy,
                  ForwardIt first, ForwardIt last, const T& value );
(since C++17)
(until C++26)

(2)
template< class ExecutionPolicy, class ForwardIt,
          class T = typename std::iterator_traits<ForwardIt>::value_type >
ForwardIt remove( ExecutionPolicy&& policy,
                  ForwardIt first, ForwardIt last, const T& value );
(since C++26)

(3)
template< class ForwardIt, class UnaryPred >
ForwardIt remove_if( ForwardIt first, ForwardIt last, UnaryPred p );
(constexpr since C++20)

(4)
template< class ExecutionPolicy, class ForwardIt, class UnaryPred >
ForwardIt remove_if( ExecutionPolicy&& policy,
                     ForwardIt first, ForwardIt last, UnaryPred p );
(since C++17)

Removes all elements satisfying specific criteria from the range [first, last) and returns a past-the-end iterator for the new end of the range.

1) — removes all elements that are equal to value (using operator==).
3) — removes all elements for which predicate p returns true.
2,4) — same as (1,3), but executed according to policy. These overloads participate in overload resolution only if std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true (until C++20). Since C++20, only if std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> is true.

If the value type of ForwardIt is not CopyAssignable, the behavior is undefined (until C++11). If the type of *first is not MoveAssignable, the behavior is undefined (since C++11).

🦋 Explanation 🦋

Removing is done by shifting the elements in the range in such a way that the elements that are not to be removed appear in the beginning of the range. No cap, that’s the whole trick.

Shifting is done by copy assignment (until C++11), or move assignment (since C++11).
The removing operation is stable: the relative order of the elements not to be removed stays the same. Periodt.
The underlying sequence of [first, last) is not shortened by the removing operation. Given result as the returned iterator:
- All iterators in [result, last) are still dereferenceable.
- Each element of [result, last) has a valid but unspecified state, because move assignment can eliminate elements by moving from elements that were originally in that range (since C++11).

🎀 Parameters 🎀

first, last — the range of elements to process.
value — the value of elements to remove.
policy — the execution policy to use. See execution policy for details.
p — unary predicate which returns true if the element should be removed. The expression p(v) must be convertible to bool for every argument v of type (possibly const) VT, where VT is the value type of ForwardIt, regardless of value category, and must not modify v. Thus, a parameter type of VT& is not allowed, nor is VT unless for VT a move is equivalent to a copy (since C++11).

🌈 Type requirements 🌈

ForwardIt must meet the requirements of LegacyForwardIterator.
UnaryPredicate must meet the requirements of Predicate.

💫 Return value 💫

Past-the-end iterator for the new range of values (if this is not end, then it points to an unspecified value, and so do iterators to any values between this iterator and end).

🔥 Complexity 🔥

Given (\scriptsize N)N as std::distance(first, last):

1,2) — exactly (\scriptsize N)N comparisons using operator==.
3,4) — exactly (\scriptsize N)N applications of the predicate p.

💀 Exceptions 💀

The overloads with a template parameter named ExecutionPolicy report errors as follows:

If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
If the algorithm fails to allocate memory, std::bad_alloc is thrown.

🧚 Possible implementation 🧚

remove (1)

template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type>
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 (3)

template<class ForwardIt, class UnaryPred>
ForwardIt remove_if(ForwardIt first, ForwardIt last, UnaryPred 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;
}

👑 Notes 👑

A call to remove is typically followed by a call to a container’s erase member function to actually remove elements from the container. These two invocations together constitute a so-called Erase-remove idiom.
The same effect can also be achieved by the following non-member functions (since C++20):
- std::erase, which has overloads for all standard sequence containers.
- std::erase_if, which has overloads for all standard containers.
The similarly-named container member functions list::remove, list::remove_if, forward_list::remove, and forward_list::remove_if erase the removed elements.
These algorithms cannot be used with associative containers such as std::set and std::map because their iterator types do not dereference to MoveAssignable types (the keys in these containers are not modifiable).
The standard library also defines an overload of std::remove in <cstdio>, which takes a const char* and is used to delete files.
Because std::remove takes value by reference, it can have unexpected behavior if it is a reference to an element of the range [first, last).

Warning bestie: that last one is a real “be careful” moment. If value is a reference into the same range, the vibes are not immaculate.

Feature-test macro

__cpp_lib_algorithm_default_value_type — value 202403, standard (C++26), feature: “List-initialization for algorithms (1,2)”.

🍓 Example 🍓

The following code removes all spaces from a string by shifting all non-space characters to the left and then erasing the extra. This is an example of Erase-remove idiom.

// Run this code

#include <algorithm>
#include <cassert>
#include <cctype>
#include <complex>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>

int main()
{
    std::string str1{"Text with some   spaces"};

    auto noSpaceEnd = std::remove(str1.begin(), str1.end(), ' ');

    // The spaces are removed from the string only logically.
    // Note, we use view, the original string is still not shrunk:
    std::cout << std::string_view(str1.begin(), noSpaceEnd)
              << " size: " << str1.size() << '\n';

    str1.erase(noSpaceEnd, str1.end());

    // The spaces are removed from the string physically.
    std::cout << str1 << " size: " << 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';

    std::vector<std::complex<double>> nums{{2, 2}, {1, 3}, {4, 8}};
    #ifdef __cpp_lib_algorithm_default_value_type
        nums.erase(std::remove(nums.begin(), nums.end(), {1, 3}), nums.end());
    #else
        nums.erase(std::remove(nums.begin(), nums.end(),
                               std::complex<double>{1, 3}),
                   nums.end());
    #endif
    assert((nums == std::vector<std::complex<double>>{{2, 2}, {4, 8}}));
}

⭐ Output ⭐

Textwithsomespaces size: 23
Textwithsomespaces size: 18
Textwithsomewhitespaces

🙈 Defect reports 🙈

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR: LWG 283 — applied to: C++98. Behavior as published: “T was required to be EqualityComparable, but the value type of ForwardIt is not always T”. Correct behavior: “required the value type of ForwardIt to be CopyAssignable instead”.

💜 See also 💜

remove_copy, remove_copy_if — copies a range of elements omitting those that satisfy specific criteria (function template).
unique — removes consecutive duplicate elements in a range (function template).
ranges::remove (C++20), ranges::remove_if (C++20) — removes elements satisfying specific criteria (niebloid).

okay that’s the whole page, bestie 💖 — source/version: http://cppreference.com, date: 2024.06.10, and the page is std::remove,std::remove_if(3). now go forth and erase responsibly ✨

📦 where this page comes from

nixpkgs unstable: stdman 2024.07.05
opensuse-leap 16.0: stdman 2024.07.05-bp160.1.9 · MIT
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms

std::remove,std::remove_if(3)