std::flat_map<Key,T,Compare,KeyContainer,MappedContainer>::erase

iterator erase( iterator position );	(1)	(since C++23)
iterator erase( const_iterator pos );	(2)	(since C++23)
iterator erase( const_iterator first, const_iterator last );	(3)	(since C++23)
size_type erase( const Key& key );	(4)	(since C++23)
template< class K > size_type erase( K&& x );	(5)	(since C++23)

Removes specified elements from the container.

1,2) Removes the element at pos.

3) Removes the elements in the range [first, last), which must be a valid range in *this.

4) Removes the element (if one exists) with the key equivalent to key.

5) Removes all elements with key that compares equivalent to the value x. This overload participates in overload resolution only if the qualified-id Compare::is_transparent is valid and denotes a type, and neither iterator nor const_iterator is implicitly convertible from K. It allows calling this function without constructing an instance of Key.

The iterator pos must be valid and dereferenceable. Thus the end() iterator (which is valid, but is not dereferenceable) cannot be used as a value for pos.

Parameters

pos	-	iterator to the element to remove
first, last	-	range of elements to remove
key	-	key value of the elements to remove
x	-	a value of any type that can be transparently compared with a key denoting the elements to remove

Return value

1-3) Iterator following the last removed element.

4) Number of elements removed (0 or 1).

5) Number of elements removed.

Exceptions

1-3) Throws nothing.

4,5) Any exceptions thrown by the Compare object.

Complexity

Depends on underlying containers. Typically linear.

Example

Run this code

#include <flat_map>
#include <iostream>
 
int main()
{
    std::flat_map<int, std::string> c =
    {
        {1, "one"}, {2, "two"}, {3, "three"},
        {4, "four"}, {5, "five"}, {6, "six"}
    };
 
    // erase all odd numbers from c
    for (auto it = c.begin(); it != c.end();)
    {
        if (it->first % 2 != 0)
            it = c.erase(it);
        else
            ++it;
    }
 
    for (auto& p : c)
        std::cout << p.second << ' ';
    std::cout << '\n';
}

Output:

two four six

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)
Execution support library (C++26)
Technical specifications
Symbols index
External libraries

Sequence
array (C++11)
vector
vector<bool>
inplace_vector (C++26)
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)
Tables
Iterator invalidation
Member function table
Non-member function table