Difference between revisions of "cpp/container"

Revision as of 07:19, 22 September 2022

The Containers library is a generic collection of class templates and algorithms that allow programmers to easily implement common data structures like queues, lists and stacks. There are two(until C++11)three(since C++11) classes of containers:

sequence containers,
associative containers, and

unordered associative containers,

(since C++11)

each of which is designed to support a different set of operations.

The container manages the storage space that is allocated for its elements and provides member functions to access them, either directly or through iterators (objects with properties similar to pointers).

Most containers have at least several member functions in common, and share functionalities. Which container is the best for the particular application depends not only on the offered functionality, but also on its efficiency for different workloads.

set	collection of unique keys, sorted by keys (class template) [edit]
map	collection of key-value pairs, sorted by keys, keys are unique (class template) [edit]
multiset	collection of keys, sorted by keys (class template) [edit]
multimap	collection of key-value pairs, sorted by keys (class template) [edit]

Unordered associative containers (since C++11)

Unordered associative containers implement unsorted (hashed) data structures that can be quickly searched ( $O(1)$ amortized, $O(n)$ worst-case complexity).

unordered_set (C++11)	collection of unique keys, hashed by keys (class template) [edit]
unordered_map (C++11)	collection of key-value pairs, hashed by keys, keys are unique (class template) [edit]
unordered_multiset (C++11)	collection of keys, hashed by keys (class template) [edit]
unordered_multimap (C++11)	collection of key-value pairs, hashed by keys (class template) [edit]

Container adaptors

Container adaptors provide a different interface for sequential containers.

stack	adapts a container to provide stack (LIFO data structure) (class template) [edit]
queue	adapts a container to provide queue (FIFO data structure) (class template) [edit]
priority_queue	adapts a container to provide priority queue (class template) [edit]
flat_set (C++23)	adapts a container to provide a collection of unique keys, sorted by keys (class template) [edit]
flat_map (C++23)	adapts two containers to provide a collection of key-value pairs, sorted by unique keys (class template) [edit]
flat_multiset (C++23)	adapts a container to provide a collection of keys, sorted by keys (class template) [edit]
flat_multimap (C++23)	adapts two containers to provide a collection of key-value pairs, sorted by keys (class template) [edit]

Views

span(since C++20) and mdspan(since C++23) are non-owning views over a contiguous sequence of objects, the storage of which is owned by some other object.

span (C++20)	a non-owning view over a contiguous sequence of objects (class template) [edit]
mdspan (C++23)	a multi-dimensional non-owning array view (class template) [edit]

Iterator invalidation

Read-only methods never invalidate iterators or references. Methods which modify the contents of a container may invalidate iterators and/or references, as summarized in this table.

Category	Container	After insertion, are...		After erasure, are...		Conditionally
Category	Container	iterators valid?	references valid?	iterators valid?	references valid?	Conditionally
Sequence containers	`array`	N/A		N/A
	`vector`	No		N/A		Insertion changed capacity
		Yes		Yes		Before modified element(s) (for insertion only if capacity didn't change)
		No		No		At or after modified element(s)
	`deque`	No	Yes	Yes, except erased element(s)		Modified first or last element
	`deque`	No	No	No		Modified middle only
	`list`	Yes		Yes, except erased element(s)
	`forward_list`	Yes		Yes, except erased element(s)
Associative containers	`set` `multiset` `map` `multimap`	Yes		Yes, except erased element(s)
Unordered associative containers	`unordered_set` `unordered_multiset` `unordered_map` `unordered_multimap`	No	Yes	N/A		Insertion caused rehash
Unordered associative containers		Yes	Yes	Yes, except erased element(s)		No rehash

Here, insertion refers to any method which adds one or more elements to the container and erasure refers to any method which removes one or more elements from the container.

Examples of insertion methods are std::set::insert, std::map::emplace, std::vector::push_back, and std::deque::push_front.

Note that std::unordered_map::operator[] also counts, as it may insert an element into the map.

(since C++11)

Examples of erasure methods are std::set::erase, std::vector::pop_back, std::deque::pop_front, and std::map::clear.
- clear invalidates all iterators and references. Because it erases all elements, this technically complies with the rules above.

Unless otherwise specified (either explicitly or by defining a function in terms of other functions), passing a container as an argument to a library function never invalidate iterators to, or change the values of, objects within that container.

The past-the-end iterator deserves particular mention. In general this iterator is invalidated as though it were a normal iterator to a non-erased element. So std::set::end is never invalidated, std::unordered_set::end is invalidated only on rehash(since C++11), std::vector::end is always invalidated (since it is always after the modified elements), and so on.

There is one exception: an erasure which deletes the last element of a std::deque does invalidate the past-the-end iterator, even though it is not an erased element of the container (or an element at all). Combined with the general rules for std::deque iterators, the net result is that the only modifying operation which does not invalidate std::deque::end is an erasure which deletes the first element, but not the last.

Thread safety

All container functions can be called concurrently by different threads on different containers. More generally, the C++ standard library functions do not read objects accessible by other threads unless those objects are directly or indirectly accessible via the function arguments, including the this pointer.
All const member functions can be called concurrently by different threads on the same container. In addition, the member functions begin(), end(), rbegin(), rend(), front(), back(), data(), find(), lower_bound(), upper_bound(), equal_range(), at(), and, except in associative containers, operator[], behave as const for the purposes of thread safety (that is, they can also be called concurrently by different threads on the same container). More generally, the C++ standard library functions do not modify objects unless those objects are accessible, directly or indirectly, via the function's non-const arguments, including the this pointer.
Different elements in the same container can be modified concurrently by different threads, except for the elements of std::vector<bool> (for example, a vector of std::future objects can be receiving values from multiple threads).
Iterator operations (e.g. incrementing an iterator) read, but do not modify the underlying container, and may be executed concurrently with operations on other iterators on the same container, with the const member functions, or reads from the elements. Container operations that invalidate any iterators modify the container and cannot be executed concurrently with any operations on existing iterators even if those iterators are not invalidated.
Elements of the same container can be modified concurrently with those member functions that are not specified to access these elements. More generally, the C++ standard library functions do not read objects indirectly accessible through their arguments (including other elements of a container) except when required by its specification.
In any case, container operations (as well as algorithms, or any other C++ standard library functions) may be parallelized internally as long as this does not change the user-visible results (e.g. std::transform may be parallelized, but not std::for_each which is specified to visit each element of a sequence in order)

(since C++11)

Member function table

	- functions present in C++03
	- functions present since C++11
	- functions present since C++17
	- functions present since C++20
	- functions present since C++23

Sequence containers Associative containers Unordered associative containers Container adaptors

Header <array> <vector> <deque> <forward_list> <list> <set> <map> <unordered_set> <unordered_map> <stack> <queue> <flat_set> <flat_map>

Container

array

vector

deque

forward_list

list

set

map

stack

queue

(constructor)

(implicit)

vector

deque

forward_list

list

set

map

stack

queue

(destructor)

(implicit)

~vector

~deque

~forward_list

~list

~set

~multiset

~map

~multimap

~unordered_set

~unordered_multiset

~unordered_map

~unordered_multimap

~stack

~queue

operator=

(implicit)

operator=

assign

Iterators

begin

cbegin

@@ Line 449: / Line 449: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/at }}
 | {{n/a|}}
 |-
@@ Line 472: / Line 472: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/operator_at |operator[] }}
 | {{n/a|}}
 |-
@@ Line 562: / Line 562: @@
 | {{cpp/container/table cell o | /queue/empty }}
 | {{cpp/container/table cell o | /priority_queue/empty }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/empty }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/empty }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/empty }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/empty }}
 |-
 <!-- -->
@@ Line 585: / Line 585: @@
 | {{cpp/container/table cell o | /queue/size }}
 | {{cpp/container/table cell o | /priority_queue/size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/size }}
 |-
 <!-- -->
@@ Line 608: / Line 608: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/max_size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/max_size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/max_size }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/max_size }}
 |-
 <!-- -->
@@ Line 723: / Line 723: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/clear }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/clear}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/clear }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/clear }}
 |-
 <!-- -->
@@ Line 746: / Line 746: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/insert }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/insert }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/insert }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/insert }}
 |-
 <!-- -->
@@ Line 771: / Line 771: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/insert_or_assign }}
 | {{n/a|}}
 |-
@@ Line 792: / Line 792: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/emplace }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/emplace }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/emplace }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/emplace }}
 |-
 <!-- -->
@@ Line 815: / Line 815: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/emplace_hint }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/emplace_hint }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/emplace_hint }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/emplace_hint }}
 |-
 <!-- -->
@@ Line 840: / Line 840: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/try_emplace }}
 | {{n/a|}}
 |-
@@ Line 861: / Line 861: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_set/erase }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multiset/erase }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_map/erase }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /flat_multimap/erase }}
 |-
 <!-- -->
@@ Line 1,022: / Line 1,022: @@
 | {{cpp/container/table cell n | /queue/swap }}
 | {{cpp/container/table cell n | /priority_queue/swap }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /unordered_set/swap }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /unordered_multiset/swap }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /unordered_map/swap }}
-| {{n/a|}}
+| {{cpp/container/table cell 23 | /unordered_multimap/swap }}
 |-
 <!-- -->
@@ Line 1,068: / Line 1,068: @@
 | {{n/a|}}
 | {{n/a|}}
-| {{n/a|}}
+| {{n/a|}} <!-- note: there is 'extract' but with an entirely different meaning -->
-| {{n/a|}}
+| {{n/a|}} <!-- note: there is 'extract' but with an entirely different meaning -->
-| {{n/a|}}
+| {{n/a|}} <!-- note: there is 'extract' but with an entirely different meaning -->
-| {{n/a|}}
+| {{n/a|}} <!-- note: there is 'extract' but with an entirely different meaning -->
 |-
 ! rowspan="6" | List operations

array (C++11)	fixed-sized inplace contiguous array (class template) [edit]
vector	dynamic contiguous array (class template) [edit]
deque	double-ended queue (class template) [edit]
forward_list (C++11)	singly-linked list (class template) [edit]
list	doubly-linked list (class template) [edit]

cppreference.com

Namespaces

Variants

Views

Actions

Difference between revisions of "cpp/container"

Revision as of 07:19, 22 September 2022

Contents

Sequence containers

Associative containers

Unordered associative containers (since C++11)

Container adaptors

Views

Iterator invalidation

Thread safety

Member function table

Non-member function table

Defect reports

See also

Navigation

Toolbox