(C++17) | ||||
Sequence | ||||
(C++11) | ||||
(C++26) | ||||
(C++26) | ||||
(C++11) | ||||
Associative | ||||
map | ||||
Unordered associative | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
Adaptors | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
Views | ||||
(C++20) | ||||
(C++23) | ||||
Tables | ||||
Iterator invalidation | ||||
Member function table | ||||
Non-member function table |
std::map
Member functions | |||||||
Non-member functions | |||||||
| |||||||
Deduction guides(C++17) |
Defined in header <map> | ||
template< class Key, | (1) | |
namespace pmr{ template< | (2) | (since C++17) |
std::map
is a sorted associative container that contains key-value pairs with unique keys. Keys are sorted by using the comparison functionCompare
. Search, removal, and insertion operations have logarithmic complexity. Maps are usually implemented asRed–black trees.
Iterators ofstd::map
iterate in ascending order of keys, where ascending is defined by the comparison that was used for construction. That is, given
std::map
m.value_comp()(*it_l,*it_r)==true (least to greatest if using the default comparison).
Everywhere the standard library uses theCompare requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objectsa andb are considered equivalent (not unique) if neither compares less than the other:!comp(a, b)&&!comp(b, a).
std::map
meets the requirements ofContainer,AllocatorAwareContainer,AssociativeContainer andReversibleContainer.
All member functions ofstd::map areconstexpr: it is possible to create and usestd::map objects in the evaluation of a constant expression.However, | (since C++26) |
Contents |
This section is incomplete Reason: Add descriptions of the template parameters. |
Type | Definition | ||||
key_type | Key [edit] | ||||
mapped_type | T [edit] | ||||
value_type | std::pair<const Key, T>[edit] | ||||
size_type | Unsigned integer type (usuallystd::size_t)[edit] | ||||
difference_type | Signed integer type (usuallystd::ptrdiff_t)[edit] | ||||
key_compare | Compare [edit] | ||||
allocator_type | Allocator [edit] | ||||
reference | value_type&[edit] | ||||
const_reference | const value_type&[edit] | ||||
pointer |
| ||||
const_pointer |
| ||||
iterator | LegacyBidirectionalIterator andConstexprIterator(since C++26) tovalue_type [edit] | ||||
const_iterator | LegacyBidirectionalIterator andConstexprIterator(since C++26) toconst value_type[edit] | ||||
reverse_iterator | std::reverse_iterator<iterator>[edit] | ||||
const_reverse_iterator | std::reverse_iterator<const_iterator>[edit] | ||||
node_type (since C++17) | a specialization ofnode handle representing a container node[edit] | ||||
insert_return_type (since C++17) | type describing the result of inserting anode_type , a specialization oftemplate<class Iter,class NodeType> |
compares objects of typevalue_type (class)[edit] |
constructs themap (public member function)[edit] | |
destructs themap (public member function)[edit] | |
assigns values to the container (public member function)[edit] | |
returns the associated allocator (public member function)[edit] | |
Element access | |
access specified element with bounds checking (public member function)[edit] | |
access or insert specified element (public member function)[edit] | |
Iterators | |
(C++11) | returns an iterator to the beginning (public member function)[edit] |
(C++11) | returns an iterator to the end (public member function)[edit] |
(C++11) | returns a reverse iterator to the beginning (public member function)[edit] |
(C++11) | returns a reverse iterator to the end (public member function)[edit] |
Capacity | |
checks whether the container is empty (public member function)[edit] | |
returns the number of elements (public member function)[edit] | |
returns the maximum possible number of elements (public member function)[edit] | |
Modifiers | |
clears the contents (public member function)[edit] | |
inserts elementsor nodes(since C++17) (public member function)[edit] | |
(C++23) | inserts a range of elements (public member function)[edit] |
(C++17) | inserts an element or assigns to the current element if the key already exists (public member function)[edit] |
(C++11) | constructs element in-place (public member function)[edit] |
(C++11) | constructs elements in-place using a hint (public member function)[edit] |
(C++17) | inserts in-place if the key does not exist, does nothing if the key exists (public member function)[edit] |
erases elements (public member function)[edit] | |
swaps the contents (public member function)[edit] | |
(C++17) | extracts nodes from the container (public member function)[edit] |
(C++17) | splices nodes from another container (public member function)[edit] |
Lookup | |
returns the number of elements matching specific key (public member function)[edit] | |
finds element with specific key (public member function)[edit] | |
(C++20) | checks if the container contains element with specific key (public member function)[edit] |
returns range of elements matching a specific key (public member function)[edit] | |
returns an iterator to the first elementnot less than the given key (public member function)[edit] | |
returns an iterator to the first elementgreater than the given key (public member function)[edit] | |
Observers | |
returns the function that compares keys (public member function)[edit] | |
returns the function that compares keys in objects of typevalue_type (public member function)[edit] |
(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(C++20) | lexicographically compares the values of twomap s(function template)[edit] |
specializes thestd::swap algorithm (function template)[edit] | |
(C++20) | erases all elements satisfying specific criteria (function template)[edit] |
Deduction guides | (since C++17) |
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_containers_ranges | 202202L | (C++23) | Ranges construction and insertion for containers |
__cpp_lib_constexpr_map | 202502L | (C++26) | constexprstd::map |
#include <iostream>#include <map>#include <string>#include <string_view> void print_map(std::string_view comment,const std::map<std::string,int>& m){std::cout<< comment;// Iterate using C++17 facilitiesfor(constauto&[key, value]: m)std::cout<<'['<< key<<"] = "<< value<<"; "; // C++11 alternative:// for (const auto& n : m)// std::cout << n.first << " = " << n.second << "; ";//// C++98 alternative:// for (std::map<std::string, int>::const_iterator it = m.begin(); it != m.end(); ++it)// std::cout << it->first << " = " << it->second << "; "; std::cout<<'\n';} int main(){// Create a map of three (string, int) pairs std::map<std::string,int> m{{"CPU",10},{"GPU",15},{"RAM",20}}; print_map("1) Initial map: ", m); m["CPU"]=25;// update an existing value m["SSD"]=30;// insert a new value print_map("2) Updated map: ", m); // Using operator[] with non-existent key always performs an insertstd::cout<<"3) m[UPS] = "<< m["UPS"]<<'\n'; print_map("4) Updated map: ", m); m.erase("GPU"); print_map("5) After erase: ", m); std::erase_if(m,[](constauto& pair){return pair.second>25;}); print_map("6) After erase: ", m);std::cout<<"7) m.size() = "<< m.size()<<'\n'; m.clear();std::cout<<std::boolalpha<<"8) Map is empty: "<< m.empty()<<'\n';}
Output:
1) Initial map: [CPU] = 10; [GPU] = 15; [RAM] = 20;2) Updated map: [CPU] = 25; [GPU] = 15; [RAM] = 20; [SSD] = 30;3) m[UPS] = 04) Updated map: [CPU] = 25; [GPU] = 15; [RAM] = 20; [SSD] = 30; [UPS] = 0;5) After erase: [CPU] = 25; [RAM] = 20; [SSD] = 30; [UPS] = 0;6) After erase: [CPU] = 25; [RAM] = 20; [UPS] = 0;7) m.size() = 38) Map is empty: true
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 230 | C++98 | Key was not required to beCopyConstructible(a key of type Key might not be able to be constructed) | Key is also required tobeCopyConstructible |
LWG 464 | C++98 | accessing a constmap by key was inconvenient | at function provided |
collection of key-value pairs, sorted by keys (class template)[edit] | |
(C++11) | collection of key-value pairs, hashed by keys, keys are unique (class template)[edit] |
(C++23) | adapts two containers to provide a collection of key-value pairs, sorted by unique keys (class template)[edit] |