std::erase, std::erase_if (std::list)

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Iterator invalidation

Member function table

Non-member function table

 

std::list

Member functions

list::list

list::~list

list::operator=

list::assign

list::assign_range (C++23)

list::get_allocator

Element access

list::front

list::back

Iterators

list::beginlist::cbegin (C++11)

list::endlist::cend (C++11)

list::rbeginlist::crbegin (C++11)

list::rendlist::crend (C++11)

Capacity

list::empty

list::size

list::max_size

Modifiers

list::clear

list::insert

list::insert_range (C++23)

list::emplace (C++11)

list::erase

list::push_front

list::emplace_front (C++11)

list::prepend_range (C++23)

list::pop_front

list::push_back

list::emplace_back (C++11)

list::append_range (C++23)

list::pop_back

list::resize

list::swap

Operations

list::merge

list::splice

list::removelist::remove_if

list::reverse

list::unique

list::sort

Non-member functions

std::swap

eraseerase_if (C++20)(C++20)

operator==operator!=operator<operator>operator<=operator>=operator<=> (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)

Deduction guides(C++17)

 

Defined in header <list>
template< class T, class Alloc, class U > typename std::list<T, Alloc>::size_type     erase( std::list<T, Alloc>& c, const U& value );	(1)	(since C++20)
template< class T, class Alloc, class Pred > typename std::list<T, Alloc>::size_type     erase_if( std::list<T, Alloc>& c, Pred pred );	(2)	(since C++20)

1) Erases all elements that compare equal to value from the container. Equivalent to return c.remove_if([&](auto& elem) { return elem == value; });

2) Erases all elements that satisfy the predicate pred from the container. Equivalent to return c.remove_if(pred);

Parameters

c	-	container from which to erase
value	-	value to be removed
pred	-	unary predicate which returns ​true if the element should be erased. The expression pred(v) must be convertible to bool for every argument v of type (possibly const) T, regardless of value category, and must not modify v. Thus, a parameter type of T&is not allowed, nor is T unless for T a move is equivalent to a copy (since C++11). ​

Return value

The number of erased elements.

Complexity

Linear.

Notes

Unlike std::list::remove, erase accepts heterogeneous types and does not force a conversion to the container's value type before invoking the == operator.

Example

Run this code

#include <iostream>
#include <numeric>
#include <string_view>
#include <list>
 
void print_container(std::string_view comment, const std::list<char>& c)
{
    std::cout << comment << "{ ";
    for (char x : c)
        std::cout << x << ' ';
    std::cout << "}\n";
}
 
int main()
{
    std::list<char> cnt(10);
    std::iota(cnt.begin(), cnt.end(), '0');
    print_container("Initially, cnt = ", cnt);
 
    std::erase(cnt, '3');
    print_container("After erase '3', cnt = ", cnt);
 
    auto erased = std::erase_if(cnt, [](char x) { return (x - '0') % 2 == 0; });
    print_container("After erase all even numbers, cnt = ", cnt);
    std::cout << "Erased even numbers: " << erased << '\n';
}

Output:

Initially, cnt = { 0 1 2 3 4 5 6 7 8 9 }
After erase '3', cnt = { 0 1 2 4 5 6 7 8 9 }
After erase all even numbers, cnt = { 1 5 7 9 }
Erased even numbers: 5

See also

removeremove_if	removes elements satisfying specific criteria (function template)
removeremove_if	removes elements satisfying specific criteria (public member function)