On this page
std::map<Key,T,Compare,Allocator>::map
(1) | ||
|
(until C++11) | |
|
(since C++11) | |
|
(2) | |
|
(3) | (since C++11) |
|
(4) | |
|
(5) | (since C++14) |
|
(6) | |
|
(7) | (since C++11) |
|
(8) | (since C++11) |
|
(9) | (since C++11) |
|
(10) | (since C++11) |
|
(11) | (since C++14) |
|
(12) | (since C++23) |
|
(13) | (since C++23) |
Constructs new container from a variety of data sources and optionally using user supplied allocator alloc
or comparison function object comp
.
[
first
,
last
)
. If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).
other
.
If |
(since C++11) |
During class template argument deduction, only the first argument contributes to the deduction of the container's |
(since C++23) |
other
using move semantics. If alloc
is not provided, allocator is obtained by move-construction from the allocator belonging to other
.
During class template argument deduction, only the first argument contributes to the deduction of the container's |
(since C++23) |
init
.If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).
rg
. If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).
Parameters
alloc | - | allocator to use for all memory allocations of this container |
comp | - | comparison function object to use for all comparisons of keys |
first, last | - | the range to copy the elements from |
other | - | another container to be used as source to initialize the elements of the container with |
init | - | initializer list to initialize the elements of the container with |
rg | - | a container compatible range, that is, an input_range whose elements are convertible to value_type |
Type requirements | ||
-InputIt must meet the requirements of LegacyInputIterator. |
||
-Compare must meet the requirements of Compare. |
||
-Allocator must meet the requirements of Allocator. |
Complexity
std::distance(first, last)
in general, linear in \(\scriptsize N\)N if [
first
,
last
)
is already sorted by value_comp()
.
other
.
alloc
is given and alloc != other.get_allocator()
, then linear.
init.size()
in general, linear in \(\scriptsize N\)N if init
is already sorted by value_comp()
.
ranges::distance(rg)
in general, linear in \(\scriptsize N\)N if rg
is already sorted by value_comp()
.
Exceptions
Calls to Allocator::allocate
may throw.
Notes
After container move construction (overload (8,9)), references, pointers, and iterators (other than the end iterator) to other
remain valid, but refer to elements that are now in *this
. The current standard makes this guarantee via the blanket statement in [container.reqmts]/67, and a more direct guarantee is under consideration via LWG issue 2321.
Although not formally required until C++23, some implementations has already put the template parameter Allocator
into non-deduced contexts in earlier modes.
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_containers_ranges |
202202L | (C++23) | Ranges-aware construction and insertion; overloads (12,13) |
Example
#include <iomanip>
#include <iostream>
#include <map>
#include <string>
template<typename Key, typename Value, typename Cmp>
std::ostream& operator<<(std::ostream& os, std::map<Key, Value, Cmp> const& map)
{
os << "{ ";
for (auto const& p : map)
os << '\'' << p.first << "' is " << p.second << ", ";
return os << "}\n";
}
struct Point
{
double x, y;
friend std::ostream& operator<<(std::ostream& os, Point pt)
{
return os << '(' << pt.x << ", " << pt.y << ')';
}
};
struct PointCmp
{
bool operator()(const Point& lhs, const Point& rhs) const
{
return lhs.x < rhs.x; // NB: y is intentionally ignored
}
};
int main()
{
// (1) Default constructor
std::map<std::string, int> map1;
map1["something"] = 69;
map1["anything"] = 199;
map1["that thing"] = 50;
std::cout << "map1 = " << map1;
// (4) Range constructor
std::map<std::string, int> iter(map1.find("anything"), map1.end());
std::cout << "\niter = " << iter;
std::cout << "map1 = " << map1;
// (6) Copy constructor
std::map<std::string, int> copied(map1);
std::cout << "\ncopied = " << copied;
std::cout << "map1 = " << map1;
// (8) Move constructor
std::map<std::string, int> moved{std::move(map1)};
std::cout << "\nmoved = " << moved;
std::cout << "map1 = " << map1;
// (10) Initializer list constructor
const std::map<std::string, int> init
{
{"this", 100},
{"can", 100},
{"be", 100},
{"const", 100}
};
std::cout << "\ninit = " << init;
std::cout << "\nCustom Key class option 1:\n";
// Use a comparison struct
std::map<Point, double, PointCmp> mag =
{
{{5, -12}, 13},
{{3, 4}, 5},
{{-8, -15}, 17}
};
std::cout << "mag = " << mag << '\n';
std::cout << "Custom Key class option 2:\n";
// Use a comparison lambda
// This lambda sorts points according to their magnitudes, where
// these magnitudes are taken from the local variable mag.
auto cmpLambda = [&mag](const Point& lhs, const Point& rhs)
{
return mag[lhs] < mag[rhs];
};
// You could also use a lambda that is not dependent on local variables, like this:
// auto cmpLambda = [](const Point& lhs, const Point& rhs){ return lhs.y < rhs.y; };
std::map<Point, double, decltype(cmpLambda)> magy(cmpLambda);
// Various ways of inserting elements:
magy.insert(std::pair<Point, double>({5, -12}, 13));
magy.insert({{3, 4}, 5});
magy.insert({Point{-8.0, -15.0}, 17});
std::cout << "magy = " << magy << '\n';
}
Output:
map1 = { 'anything' is 199, 'something' is 69, 'that thing' is 50, }
iter = { 'anything' is 199, 'something' is 69, 'that thing' is 50, }
map1 = { 'anything' is 199, 'something' is 69, 'that thing' is 50, }
copied = { 'anything' is 199, 'something' is 69, 'that thing' is 50, }
map1 = { 'anything' is 199, 'something' is 69, 'that thing' is 50, }
moved = { 'anything' is 199, 'something' is 69, 'that thing' is 50, }
map1 = { }
init = { 'be' is 100, 'can' is 100, 'const' is 100, 'this' is 100, }
Custom Key class option 1:
mag = { '(-8, -15)' is 17, '(3, 4)' is 5, '(5, -12)' is 13, }
Custom Key class option 2:
magy = { '(3, 4)' is 5, '(5, -12)' is 13, '(-8, -15)' is 17, }
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 2076 | C++11 | overload (4) conditionally required Key and T to be CopyInsertable into *this |
not required |
LWG 2193 | C++11 | the default constructor was explicit | made non-explicit |
See also
assigns values to the container (public member function) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/container/map/map