Difference between revisions of "cpp/container/vector"
m (reqmts) |
m (→See also: +) |
||
(163 intermediate revisions by 62 users not shown) | |||
Line 1: | Line 1: | ||
{{cpp/title|vector}} | {{cpp/title|vector}} | ||
{{cpp/container/vector/navbar}} | {{cpp/container/vector/navbar}} | ||
− | {{ | + | {{dcl begin}} |
+ | {{dcl header|vector}} | ||
+ | {{dcl|num=1|1= | ||
template< | template< | ||
class T, | class T, | ||
− | class Allocator | + | class Allocator = std::allocator<T> |
> class vector; | > class vector; | ||
− | }} | + | }} |
+ | {{dcl|since=c++17|num=2|1= | ||
+ | namespace pmr { | ||
+ | template< class T > | ||
+ | using vector = std::vector<T, std::pmr::polymorphic_allocator<T>>; | ||
+ | } | ||
+ | }} | ||
+ | {{dcl end}} | ||
− | {{tt|std::vector}} is a sequence container that encapsulates dynamic size arrays. | + | @1@ {{tt|std::vector}} is a sequence container that encapsulates dynamic size arrays. |
+ | @2@ {{tt|std::pmr::vector}} is an alias template that uses a [[cpp/memory/polymorphic_allocator|polymorphic allocator]]. | ||
− | + | The elements are stored contiguously, which means that elements can be accessed not only through iterators, but also using offsets to regular pointers to elements. This means that a pointer to an element of a vector may be passed to any function that expects a pointer to an element of an array. | |
− | + | ||
− | + | ||
− | The storage of the vector is handled automatically, being expanded | + | The storage of the vector is handled automatically, being expanded as needed. Vectors usually occupy more space than static arrays, because more memory is allocated to handle future growth. This way a vector does not need to reallocate each time an element is inserted, but only when the additional memory is exhausted. The total amount of allocated memory can be queried using {{lc|capacity()}} function. Extra memory can be returned to the system via a call to {{lc|shrink_to_fit()}}<ref>In libstdc++, {{tt|shrink_to_fit()}} is [https://gcc.gnu.org/onlinedocs/libstdc++/manual/strings.html#strings.string.shrink not available] in C++98 mode.</ref>. |
− | Reallocations are usually costly operations in terms of performance. {{lc|reserve()}} function can be used to eliminate reallocations if the number of elements is known beforehand. | + | Reallocations are usually costly operations in terms of performance. The {{lc|reserve()}} function can be used to eliminate reallocations if the number of elements is known beforehand. |
The complexity (efficiency) of common operations on vectors is as follows: | The complexity (efficiency) of common operations on vectors is as follows: | ||
− | * Random access - constant {{math| | + | * Random access - constant {{math|𝓞(1)}}. |
− | * Insertion or removal of elements at the end - amortized constant {{math| | + | * Insertion or removal of elements at the end - amortized constant {{math|𝓞(1)}}. |
− | * Insertion or removal of elements - linear in distance to the end of the vector {{math| | + | * Insertion or removal of elements - linear in the distance to the end of the vector {{math|𝓞(n)}}. |
− | {{tt|std::vector}} meets the requirements of {{ | + | {{tt|std::vector}} (for {{tt|T}} other than {{c/core|bool}}) meets the requirements of {{named req|Container}}{{rev inl|since=c++11|, {{named req|AllocatorAwareContainer}}}}, {{named req|SequenceContainer}}{{rev inl|since=c++17|, {{named req|ContiguousContainer}}}} and {{named req|ReversibleContainer}}. |
+ | |||
+ | {{rrev|since=c++20| | ||
+ | Member functions of {{tt|std::vector}} are {{c/core|constexpr}}: it is possible to create and use {{tt|std::vector}} objects in the evaluation of a constant expression. | ||
+ | |||
+ | However, {{tt|std::vector}} objects generally cannot be {{c/core|constexpr}}, because any dynamically allocated storage must be released in the same evaluation of constant expression. | ||
+ | }} | ||
+ | |||
+ | <references/> | ||
===Template parameters=== | ===Template parameters=== | ||
{{par begin}} | {{par begin}} | ||
− | {{par inc | cpp/container/param list T | vector}} | + | {{par inc|cpp/container/param list T|vector}} |
− | {{par inc | cpp/container/param list Allocator | vector}} | + | {{par inc|cpp/container/param list Allocator|vector}} |
{{par end}} | {{par end}} | ||
===Specializations=== | ===Specializations=== | ||
− | The standard library provides a specialization of {{tt|std::vector}} for the type {{c|bool}}, which | + | The standard library provides a specialization of {{tt|std::vector}} for the type {{c/core|bool}}, which may be optimized for space efficiency. |
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/container/dsc | + | {{dsc inc|cpp/container/dsc vector bool}} |
{{dsc end}} | {{dsc end}} | ||
===Iterator invalidation=== | ===Iterator invalidation=== | ||
− | + | {|class="dsctable" style="font-size:0.9em" | |
− | + | !Operations | |
− | + | !Invalidated | |
− | {| class="dsctable" style="font-size:0. | + | |
− | ! Operations | + | |
− | ! Invalidated | + | |
|- | |- | ||
− | | All read only operations | + | |All read only operations |
− | | Never | + | |Never. |
|- | |- | ||
− | | {{lc| | + | |{{lc|swap}}, {{lc|std::swap}} |
− | + | |{{lc|end()}} | |
|- | |- | ||
− | | {{lc| | + | |{{lc|clear}}, {{lc|1=operator=}}, {{lc|assign}} |
− | | | + | |Always. |
|- | |- | ||
− | | {{lc| | + | |{{lc|reserve}}, {{lc|shrink_to_fit}} |
− | | If the vector changed capacity, all of them. If not, | + | |If the vector changed capacity, all of them. If not, none. |
|- | |- | ||
− | | {{lc| | + | |{{lc|erase}} |
− | + | |Erased elements and all elements after them (including {{lc|end()}}). | |
|- | |- | ||
− | | {{lc|pop_back}} | + | |{{lc|push_back}}, {{lc|emplace_back}} |
− | | The element erased and {{lc|end()}}. | + | |If the vector changed capacity, all of them. If not, only {{lc|end()}}. |
+ | |- | ||
+ | |{{lc|insert}}, {{lc|emplace}} | ||
+ | |If the vector changed capacity, all of them.<br>If not, only those at or after the insertion point (including {{lc|end()}}). | ||
+ | |- | ||
+ | |{{lc|resize}} | ||
+ | |If the vector changed capacity, all of them. If not, only {{lc|end()}} and any elements erased. | ||
+ | |- | ||
+ | |{{lc|pop_back}} | ||
+ | |The element erased and {{lc|end()}}. | ||
|} | |} | ||
===Member types=== | ===Member types=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc hitem | Member type | Definition}} | + | {{dsc hitem|Member type|Definition}} |
− | {{dsc inc | cpp/container/dsc value_type | vector}} | + | {{dsc inc|cpp/container/dsc value_type|vector}} |
− | {{dsc inc | cpp/container/dsc allocator_type | vector}} | + | {{dsc inc|cpp/container/dsc allocator_type|vector}} |
− | {{dsc inc | cpp/container/dsc size_type | vector}} | + | {{dsc inc|cpp/container/dsc size_type|vector}} |
− | {{dsc inc | cpp/container/dsc difference_type | vector}} | + | {{dsc inc|cpp/container/dsc difference_type|vector}} |
− | {{dsc inc | cpp/container/dsc reference | vector}} | + | {{dsc inc|cpp/container/dsc reference|vector}} |
− | {{dsc inc | cpp/container/dsc const_reference | vector}} | + | {{dsc inc|cpp/container/dsc const_reference|vector}} |
− | {{dsc inc | cpp/container/dsc pointer | vector}} | + | {{dsc inc|cpp/container/dsc pointer|vector}} |
− | {{dsc inc | cpp/container/dsc const_pointer | vector}} | + | {{dsc inc|cpp/container/dsc const_pointer|vector}} |
− | {{dsc inc | cpp/container/dsc iterator | vector}} | + | {{dsc inc|cpp/container/dsc iterator|vector}} |
− | {{dsc inc | cpp/container/dsc const_iterator | vector}} | + | {{dsc inc|cpp/container/dsc const_iterator|vector}} |
− | {{dsc inc | cpp/container/dsc reverse_iterator | vector}} | + | {{dsc inc|cpp/container/dsc reverse_iterator|vector}} |
− | {{dsc inc | cpp/container/dsc const_reverse_iterator | vector}} | + | {{dsc inc|cpp/container/dsc const_reverse_iterator|vector}} |
{{dsc end}} | {{dsc end}} | ||
===Member functions=== | ===Member functions=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/container/dsc constructor | vector}} | + | {{dsc inc|cpp/container/dsc constructor|vector}} |
− | {{dsc inc | cpp/container/dsc destructor | vector}} | + | {{dsc inc|cpp/container/dsc destructor|vector}} |
− | {{dsc inc | cpp/container/dsc operator{{=}} | vector}} | + | {{dsc inc|cpp/container/dsc operator{{=}}|vector}} |
− | {{dsc inc | cpp/container/dsc assign | vector}} | + | {{dsc inc|cpp/container/dsc assign|vector}} |
− | {{dsc inc | cpp/container/dsc get_allocator | vector}} | + | {{dsc inc|cpp/container/dsc assign_range|vector}} |
+ | {{dsc inc|cpp/container/dsc get_allocator|vector}} | ||
− | {{dsc h2 | Element access}} | + | {{dsc h2|Element access}} |
− | {{dsc inc | cpp/container/dsc at | vector}} | + | {{dsc inc|cpp/container/dsc at|vector}} |
− | {{dsc inc | cpp/container/dsc operator_at | vector}} | + | {{dsc inc|cpp/container/dsc operator_at|vector}} |
− | {{dsc inc | cpp/container/dsc front | vector}} | + | {{dsc inc|cpp/container/dsc front|vector}} |
− | {{dsc inc | cpp/container/dsc back | vector}} | + | {{dsc inc|cpp/container/dsc back|vector}} |
− | {{dsc inc | cpp/container/dsc data | vector}} | + | {{dsc inc|cpp/container/dsc data|vector}} |
− | {{dsc h2 | Iterators}} | + | {{dsc h2|Iterators}} |
− | {{dsc inc | cpp/container/dsc begin | vector}} | + | {{dsc inc|cpp/container/dsc begin|vector}} |
− | {{dsc inc | cpp/container/dsc end | vector}} | + | {{dsc inc|cpp/container/dsc end|vector}} |
− | {{dsc inc | cpp/container/dsc rbegin | vector}} | + | {{dsc inc|cpp/container/dsc rbegin|vector}} |
− | {{dsc inc | cpp/container/dsc rend | vector}} | + | {{dsc inc|cpp/container/dsc rend|vector}} |
− | {{dsc h2 | Capacity}} | + | {{dsc h2|Capacity}} |
− | {{dsc inc | cpp/container/dsc empty | vector}} | + | {{dsc inc|cpp/container/dsc empty|vector}} |
− | {{dsc inc | cpp/container/dsc size | vector}} | + | {{dsc inc|cpp/container/dsc size|vector}} |
− | {{dsc inc | cpp/container/dsc max_size | vector}} | + | {{dsc inc|cpp/container/dsc max_size|vector}} |
− | {{dsc inc | cpp/container/dsc reserve | vector}} | + | {{dsc inc|cpp/container/dsc reserve|vector}} |
− | {{dsc inc | cpp/container/dsc capacity | vector}} | + | {{dsc inc|cpp/container/dsc capacity|vector}} |
− | {{dsc inc | cpp/container/dsc shrink_to_fit | vector}} | + | {{dsc inc|cpp/container/dsc shrink_to_fit|vector}} |
− | {{dsc h2 | Modifiers}} | + | {{dsc h2|Modifiers}} |
− | {{dsc inc | cpp/container/dsc clear | vector}} | + | {{dsc inc|cpp/container/dsc clear|vector}} |
− | {{dsc inc | cpp/container/dsc insert | vector}} | + | {{dsc inc|cpp/container/dsc insert|vector}} |
− | {{dsc inc | cpp/container/dsc emplace | vector}} | + | {{dsc inc|cpp/container/dsc insert_range|vector}} |
− | {{dsc inc | cpp/container/dsc erase | vector}} | + | {{dsc inc|cpp/container/dsc emplace|vector}} |
− | {{dsc inc | cpp/container/dsc push_back | vector}} | + | {{dsc inc|cpp/container/dsc erase|vector}} |
− | {{dsc inc | cpp/container/dsc emplace_back | vector}} | + | {{dsc inc|cpp/container/dsc push_back|vector}} |
− | {{dsc inc | cpp/container/dsc pop_back | vector}} | + | {{dsc inc|cpp/container/dsc emplace_back|vector}} |
− | {{dsc inc | cpp/container/dsc resize | vector}} | + | {{dsc inc|cpp/container/dsc append_range|vector}} |
− | {{dsc inc | cpp/container/dsc swap | vector}} | + | {{dsc inc|cpp/container/dsc pop_back|vector}} |
+ | {{dsc inc|cpp/container/dsc resize|vector}} | ||
+ | {{dsc inc|cpp/container/dsc swap|vector}} | ||
{{dsc end}} | {{dsc end}} | ||
===Non-member functions=== | ===Non-member functions=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/container/dsc operator_cmp | vector}} | + | {{dsc inc|cpp/container/dsc operator_cmp|vector}} |
− | {{dsc inc | cpp/container/dsc swap2 | vector}} | + | {{dsc inc|cpp/container/dsc swap2|vector}} |
+ | {{dsc inc|cpp/container/dsc erase seq|vector}} | ||
+ | {{dsc end}} | ||
+ | |||
+ | {{rrev|since=c++17| | ||
+ | ==={{rl|deduction guides|Deduction guides}}=== | ||
+ | }} | ||
+ | |||
+ | ===Notes=== | ||
+ | {{ftm begin|std=1|comment=1}} | ||
+ | {{ftm|__cpp_lib_containers_ranges|value=202202L|std=C++23|Ranges construction and insertion for containers}} | ||
+ | {{ftm end}} | ||
+ | |||
+ | ===Example=== | ||
+ | {{example | ||
+ | |code= | ||
+ | #include <iostream> | ||
+ | #include <vector> | ||
+ | |||
+ | int main() | ||
+ | { | ||
+ | // Create a vector containing integers | ||
+ | std::vector<int> v = {8, 4, 5, 9}; | ||
+ | |||
+ | // Add two more integers to vector | ||
+ | v.push_back(6); | ||
+ | v.push_back(9); | ||
+ | |||
+ | // Overwrite element at position 2 | ||
+ | v[2] = -1; | ||
+ | |||
+ | // Print out the vector | ||
+ | for (int n : v) | ||
+ | std::cout << n << ' '; | ||
+ | std::cout << '\n'; | ||
+ | } | ||
+ | |output= | ||
+ | 8 4 -1 9 6 9 | ||
+ | }} | ||
+ | |||
+ | ===Defect reports=== | ||
+ | {{dr list begin}} | ||
+ | {{dr list item|wg=lwg|dr=69|std=C++98|before=contiguity of the storage for elements of {{tt|vector}} was not required|after=required}} | ||
+ | {{dr list item|wg=lwg|dr=230|std=C++98|before={{tt|T}} was not required to be {{named req|CopyConstructible}}<br>(an element of type {{tt|T}} might not be able to be constructed)|after={{tt|T}} is also required to<br>be {{named req|CopyConstructible}}}} | ||
+ | {{dr list item|wg=lwg|dr=464|std=C++98|before=access to the underlying storage of an empty {{tt|vector}} resulted in UB|after={{tt|data}} function provided}} | ||
+ | {{dr list end}} | ||
+ | |||
+ | ===See also=== | ||
+ | {{dsc begin}} | ||
+ | {{dsc inc|cpp/container/dsc inplace_vector}} | ||
+ | {{dsc inc|cpp/container/dsc array}} | ||
+ | {{dsc inc|cpp/container/dsc deque}} | ||
{{dsc end}} | {{dsc end}} | ||
− | + | {{langlinks|cs|de|es|fr|it|ja|ko|pl|pt|ru|zh}} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 21:20, 2 August 2024
Defined in header <vector>
|
||
template< class T, |
(1) | |
namespace pmr { template< class T > |
(2) | (since C++17) |
std::vector
is a sequence container that encapsulates dynamic size arrays.The elements are stored contiguously, which means that elements can be accessed not only through iterators, but also using offsets to regular pointers to elements. This means that a pointer to an element of a vector may be passed to any function that expects a pointer to an element of an array.
The storage of the vector is handled automatically, being expanded as needed. Vectors usually occupy more space than static arrays, because more memory is allocated to handle future growth. This way a vector does not need to reallocate each time an element is inserted, but only when the additional memory is exhausted. The total amount of allocated memory can be queried using capacity() function. Extra memory can be returned to the system via a call to shrink_to_fit()[1].
Reallocations are usually costly operations in terms of performance. The reserve() function can be used to eliminate reallocations if the number of elements is known beforehand.
The complexity (efficiency) of common operations on vectors is as follows:
- Random access - constant 𝓞(1).
- Insertion or removal of elements at the end - amortized constant 𝓞(1).
- Insertion or removal of elements - linear in the distance to the end of the vector 𝓞(n).
std::vector
(for T
other than bool) meets the requirements of Container, AllocatorAwareContainer(since C++11), SequenceContainer, ContiguousContainer(since C++17) and ReversibleContainer.
Member functions of However, |
(since C++20) |
- ↑ In libstdc++,
shrink_to_fit()
is not available in C++98 mode.
Contents |
[edit] Template parameters
T | - | The type of the elements.
| ||||||||||||||
Allocator | - | An allocator that is used to acquire/release memory and to construct/destroy the elements in that memory. The type must meet the requirements of Allocator. The behavior is undefined(until C++20)The program is ill-formed(since C++20) if Allocator::value_type is not the same as T .
|
[edit] Specializations
The standard library provides a specialization of std::vector
for the type bool, which may be optimized for space efficiency.
space-efficient dynamic bitset (class template specialization) |
[edit] Iterator invalidation
Operations | Invalidated |
---|---|
All read only operations | Never. |
swap, std::swap | end() |
clear, operator=, assign | Always. |
reserve, shrink_to_fit | If the vector changed capacity, all of them. If not, none. |
erase | Erased elements and all elements after them (including end()). |
push_back, emplace_back | If the vector changed capacity, all of them. If not, only end(). |
insert, emplace | If the vector changed capacity, all of them. If not, only those at or after the insertion point (including end()). |
resize | If the vector changed capacity, all of them. If not, only end() and any elements erased. |
pop_back | The element erased and end(). |
[edit] Member types
Member type | Definition | ||||
value_type
|
T
| ||||
allocator_type
|
Allocator
| ||||
size_type
|
Unsigned integer type (usually std::size_t) | ||||
difference_type
|
Signed integer type (usually std::ptrdiff_t) | ||||
reference
|
value_type& | ||||
const_reference
|
const value_type& | ||||
pointer
|
| ||||
const_pointer
|
| ||||
iterator
|
| ||||
const_iterator
|
| ||||
reverse_iterator
|
std::reverse_iterator<iterator> | ||||
const_reverse_iterator
|
std::reverse_iterator<const_iterator> |
[edit] Member functions
constructs the vector (public member function) | |
destructs the vector (public member function) | |
assigns values to the container (public member function) | |
assigns values to the container (public member function) | |
(C++23) |
assigns a range of values to the container (public member function) |
returns the associated allocator (public member function) | |
Element access | |
access specified element with bounds checking (public member function) | |
access specified element (public member function) | |
access the first element (public member function) | |
access the last element (public member function) | |
direct access to the underlying contiguous storage (public member function) | |
Iterators | |
(C++11) |
returns an iterator to the beginning (public member function) |
(C++11) |
returns an iterator to the end (public member function) |
(C++11) |
returns a reverse iterator to the beginning (public member function) |
(C++11) |
returns a reverse iterator to the end (public member function) |
Capacity | |
checks whether the container is empty (public member function) | |
returns the number of elements (public member function) | |
returns the maximum possible number of elements (public member function) | |
reserves storage (public member function) | |
returns the number of elements that can be held in currently allocated storage (public member function) | |
(DR*) |
reduces memory usage by freeing unused memory (public member function) |
Modifiers | |
clears the contents (public member function) | |
inserts elements (public member function) | |
(C++23) |
inserts a range of elements (public member function) |
(C++11) |
constructs element in-place (public member function) |
erases elements (public member function) | |
adds an element to the end (public member function) | |
(C++11) |
constructs an element in-place at the end (public member function) |
(C++23) |
adds a range of elements to the end (public member function) |
removes the last element (public member function) | |
changes the number of elements stored (public member function) | |
swaps the contents (public member function) |
[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 vector s (function template) |
specializes the std::swap algorithm (function template) | |
erases all elements satisfying specific criteria (function template) |
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
#include <iostream> #include <vector> int main() { // Create a vector containing integers std::vector<int> v = {8, 4, 5, 9}; // Add two more integers to vector v.push_back(6); v.push_back(9); // Overwrite element at position 2 v[2] = -1; // Print out the vector for (int n : v) std::cout << n << ' '; std::cout << '\n'; }
Output:
8 4 -1 9 6 9
[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 69 | C++98 | contiguity of the storage for elements of vector was not required
|
required |
LWG 230 | C++98 | T was not required to be CopyConstructible(an element of type T might not be able to be constructed)
|
T is also required tobe CopyConstructible |
LWG 464 | C++98 | access to the underlying storage of an empty vector resulted in UB
|
data function provided
|
[edit] See also
(C++26) |
dynamically-resizable, fixed capacity, inplace contiguous array (class template) |
(C++11) |
fixed-sized inplace contiguous array (class template) |
double-ended queue (class template) |