Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/container/map"

From cppreference.com
< cpp‎ | container
m (→‎Notes: +FTM)
m (→‎Member types: ~Type)
 
(36 intermediate revisions by 19 users not shown)
Line 13: Line 13:
 
{{dcl|num=2|since=c++17|1=
 
{{dcl|num=2|since=c++17|1=
 
namespace pmr {
 
namespace pmr {
−
template<
+
    template<
−
    class Key,
+
        class Key,
−
    class T,
+
        class T,
−
    class Compare = std::less<Key>
+
        class Compare = std::less<Key>
−
> using map = std::map<Key, T, Compare,
+
    > using map = std::map<Key, T, Compare,
−
                      std::pmr::polymorphic_allocator<std::pair<const Key, T>>>;
+
                          std::pmr::polymorphic_allocator<std::pair<const Key, T>>>;
 
}
 
}
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
{{tt|std::map}} is a sorted associative container that contains key-value pairs with unique keys. Keys are sorted by using the comparison function {{tt|Compare}}. Search, removal, and insertion operations have logarithmic complexity. Maps are usually implemented as {{enwiki|Red–black tree}}s.
+
{{tt|std::map}} is a sorted associative container that contains key-value pairs with unique keys. Keys are sorted by using the comparison function {{tt|Compare}}. Search, removal, and insertion operations have logarithmic complexity. Maps are usually implemented as {{enwiki|Red–black tree}}s.
 +
 
 +
Iterators of {{tt|std::map}} iterate in ascending order of keys, where ascending is defined by the comparison that was used for construction. That is, given
 +
* {{c|m}}, a {{tt|std::map}}
 +
* {{c|it_l}} and {{c|it_r}}, dereferenceable iterators to {{c|m}}, with {{c|it_l < it_r}}.
 +
{{c|1=m.value_comp()(*it_l, *it_r) == true}} (least to greatest if using the default comparison).
  
 
Everywhere the standard library uses the {{named req|Compare}} requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objects {{c|a}} and {{c|b}} are considered equivalent (not unique) if neither compares less than the other: {{c|!comp(a, b) && !comp(b, a)}}.
 
Everywhere the standard library uses the {{named req|Compare}} requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objects {{c|a}} and {{c|b}} are considered equivalent (not unique) if neither compares less than the other: {{c|!comp(a, b) && !comp(b, a)}}.
Line 34: Line 39:
 
===Member types===
 
===Member types===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc hitem|Member type|Definition}}
+
{{dsc hitem|Type|Definition}}
 
{{dsc inc|cpp/container/dsc key_type|map}}
 
{{dsc inc|cpp/container/dsc key_type|map}}
 
{{dsc inc|cpp/container/dsc mapped_type|map}}
 
{{dsc inc|cpp/container/dsc mapped_type|map}}
Line 114: Line 119:
 
{{dsc end}}
 
{{dsc end}}
  
−
{{rrev|noborder=true|since=c++17|{{=}}{{=}}{{=}}{{rl|deduction guides|Deduction guides}}{{=}}{{=}}{{=}}}}
+
{{rrev|since=c++17|
 +
==={{rl|deduction guides|Deduction guides}}===
 +
}}
  
 
===Notes===
 
===Notes===
Line 122: Line 129:
  
 
===Example===
 
===Example===
−
{{example|code=
+
{{example
 +
|code=
 
#include <iostream>
 
#include <iostream>
 
#include <map>
 
#include <map>
Line 131: Line 139:
 
{
 
{
 
     std::cout << comment;
 
     std::cout << comment;
−
     // iterate using C++17 facilities
+
     // Iterate using C++17 facilities
 
     for (const auto& [key, value] : m)
 
     for (const auto& [key, value] : m)
 
         std::cout << '[' << key << "] = " << value << "; ";
 
         std::cout << '[' << key << "] = " << value << "; ";
Line 139: Line 147:
 
//      std::cout << n.first << " = " << n.second << "; ";
 
//      std::cout << n.first << " = " << n.second << "; ";
 
//
 
//
−
// C++98 alternative
+
// C++98 alternative:
−
//  for (std::map<std::string, int>::const_iterator it = m.begin(); it != m.end(); it++)
+
//  for (std::map<std::string, int>::const_iterator it = m.begin(); it != m.end(); ++it)
 
//      std::cout << it->first << " = " << it->second << "; ";
 
//      std::cout << it->first << " = " << it->second << "; ";
 
      
 
      
Line 157: Line 165:
 
     print_map("2) Updated map: ", m);
 
     print_map("2) Updated map: ", m);
  
−
     // using operator[] with non-existent key always performs an insert
+
     // Using operator[] with non-existent key always performs an insert
 
     std::cout << "3) m[UPS] = " << m["UPS"] << '\n';
 
     std::cout << "3) m[UPS] = " << m["UPS"] << '\n';
 
     print_map("4) Updated map: ", m);
 
     print_map("4) Updated map: ", m);
Line 190: Line 198:
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
 +
{{dsc inc|cpp/container/dsc multimap}}
 
{{dsc inc|cpp/container/dsc unordered_map}}
 
{{dsc inc|cpp/container/dsc unordered_map}}
−
<!-- {{dsc see cpp|cpp/language/structured binding|Structured Binding (since C++17)|nomono=true}} -->
+
{{dsc inc|cpp/container/dsc flat_map}}
 
{{dsc end}}
 
{{dsc end}}
  
 
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}
 
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}

Latest revision as of 15:48, 1 November 2024

 
C++
 
Containers library
 
std::map
Member functions
Non-member functions
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)
Deduction guides (C++17)
 
Defined in header <map>
template<

    class Key,
    class T,
    class Compare = std::less<Key>,
    class Allocator = std::allocator<std::pair<const Key, T>>

> class map;
 (1)
namespace pmr {

    template<
        class Key,
        class T,
        class Compare = std::less<Key>
    > using map = std::map<Key, T, Compare,
                           std::pmr::polymorphic_allocator<std::pair<const Key, T>>>;

}
 (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 function Compare. Search, removal, and insertion operations have logarithmic complexity. Maps are usually implemented as Red–black trees.

Iterators of std::map iterate in ascending order of keys, where ascending is defined by the comparison that was used for construction. That is, given

  • m, a std::map
  • it_l and it_r, dereferenceable iterators to m, with it_l < it_r.

m.value_comp()(*it_l, *it_r) == true (least to greatest if using the default comparison).

Everywhere the standard library uses the Compare requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objects a and b are considered equivalent (not unique) if neither compares less than the other: !comp(a, b) && !comp(b, a).

std::map meets the requirements of Container, AllocatorAwareContainer, AssociativeContainer and ReversibleContainer.

Contents

[edit] Template parameters

This section is incomplete
Reason: Add descriptions of the template parameters.

[edit] Member types

Type Definition
key_type Key[edit]
mapped_type T[edit]
value_type std::pair<const Key, T>[edit]
size_type Unsigned integer type (usually std::size_t)[edit]
difference_type Signed integer type (usually std::ptrdiff_t)[edit]
key_compare Compare[edit]
allocator_type Allocator[edit]
reference value_type&[edit]
const_reference const value_type&[edit]
pointer

Allocator::pointer

(until C++11)

std::allocator_traits<Allocator>::pointer

(since C++11)
[edit]
const_pointer

Allocator::const_pointer

(until C++11)

std::allocator_traits<Allocator>::const_pointer

(since C++11)
[edit]
iterator LegacyBidirectionalIterator to value_type[edit]
const_iterator LegacyBidirectionalIterator to const 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 of node handle representing a container node[edit]
insert_return_type (since C++17) type describing the result of inserting a node_type, a specialization of

template<class Iter, class NodeType>
struct /*unspecified*/
{
    Iter     position;
    bool     inserted;
    NodeType node;
};
instantiated with template arguments iterator and node_type.[edit]

[edit] Member classes

 compares objects of type value_type
(class) [edit]

[edit] Member functions

 constructs the map
(public member function) [edit]
destructs the map
(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 elements or 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 element not less than the given key
(public member function) [edit]
returns an iterator to the first element greater 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 type value_type
(public member function) [edit]

[edit] Non-member functions

(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 two maps
(function template) [edit]
specializes the std::swap algorithm
(function template) [edit]
(C++20)
 erases all elements satisfying specific criteria
(function template) [edit]

Deduction guides

 (since C++17)

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Ranges construction and insertion for containers

[edit] Example

Run this code
#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 facilities
    for (const auto& [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 insert
    std::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, [](const auto& 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] = 0
4) 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() = 3
8) Map is empty: true

[edit] Defect reports

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 be CopyConstructible
(a key of type Key might not be able to be constructed) 		Key is also required to
be CopyConstructible
LWG 464 C++98 accessing a const map by key was inconvenient at function provided

[edit] See also

 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]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/map&oldid=177455"