Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/named req/SequenceContainer"

From cppreference.com
< cpp‎ | named req
m (Update links.)
(Added LWG issue #2194 DR.)
 
(38 intermediate revisions by 19 users not shown)
Line 1: Line 1:
−
{{cpp/concept/title|SequenceContainer}}
+
{{cpp/named req/title|SequenceContainer}}
−
{{cpp/concept/navbar}}
+
{{cpp/named req/navbar}}
  
−
A {{ttb|SequenceContainer}} is a {{concept|Container}} that stores objects of the same type in a linear arrangement.
+
A {{named req|SequenceContainer}} is a {{named req|Container}} that stores objects of the same type in a linear arrangement.
  
 
===Requirements===
 
===Requirements===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc h1|Legend}}
+
{{dsc h2|Legend}}
−
{{dsc|{{ttb|X}}|Container type}}
+
{{dsc|{{tt|X}}|A sequence container class}}
−
{{dsc|{{ttb|T}}|Element type}}
+
{{dsc|{{tt|T}}|The element type of {{tt|X}}}}
−
{{dsc|{{ttb|a}}, {{ttb|b}}|Objects of type {{ttb|X}}}}
+
{{dsc|{{c|a}}|A value of type {{tt|X}}}}
−
{{dsc|{{ttb|t}}|Object of type {{ttb|T}} }}
+
{{dsc|{{c|u}}|The name of a declared variable}}
−
{{dsc|{{ttb|n}}|Positive integer}}
+
{{dsc|{{tt|A}}|The allocator type of {{tt|X}}:
−
{{dsc|{{ttb|i}}, {{ttb|j}}|{{concept|InputIterator}}s denoting a valid range}}
+
* {{tt|X::allocator_type}} if it exists,
−
{{dsc|{{ttb|il}}|{{lc|std::initializer_list}}<T>}}
+
* otherwise {{c/core|std::allocator<T>}}}}
−
{{dsc|{{ttb|args}}|Parameter pack}}
+
{{dsc|{{c|i}}, {{c|j}}|{{named req|InputIterator}}s such that {{range|i|j}} is a [[cpp/iterator#Ranges|valid range]] and that the iterators refer to elements implicitly convertible to {{tt|value_type}}}}
−
{{dsc|{{ttb|p}}, {{ttb|q}}|const_iterators in {{ttb|a}} }}
+
{{dsc|{{c|rg}} {{mark since c++23}}|A value of a type {{tt|R}} that models {{lti|cpp/ranges/to#container compatible range|container-compatible-range}}{{tt|<T>}}}}
 +
{{dsc|{{c|il}} {{mark since c++11}}|An object of type {{c/core|std::initializer_list<value_type>}}}}
 +
{{dsc|{{c|n}}|A value of type {{tt|X::size_type}}}}
 +
{{dsc|{{c|p}}|A valid [[cpp/iterator|const iterator]] into {{c|a}}}}
 +
{{dsc|{{c|q}}|A [[cpp/iterator#Dereferenceability and validity|valid dereferenceable]] const iterator into {{c|a}}}}
 +
{{dsc|{{c|q1}}, {{c|q2}}|Two const iterators into {{c|a}} such that {{range|q1|q2}} is a valid range}}
 +
{{dsc|{{c|t}}|An [[cpp/language/value category|lvalue]]{{rev inl|since=c++11| or const rvalue}} of type {{tt|X::value_type}}}}
 +
{{dsc|{{c|rv}} {{mark since c++11}}|A non-const rvalue of type {{tt|X::value_type}}}}
 +
{{dsc|{{tt|Args}} {{mark since c++11}}|A template parameter pack}}
 +
{{dsc|{{c|args}} {{mark since c++11}}|A function parameter pack with the pattern {{tt|Arg&&}}}}
 
{{dsc end}}
 
{{dsc end}}
  
 +
The type {{tt|X}} satisfies {{named req/core|SequenceContainer}} if
 +
* The type {{tt|X}} satisfies {{named req|Container}}, and
 +
* The following statements and expressions must be valid and have their specified effects for all sequence containers{{rev inl|since=c++11| except {{lc|std::array}} (see [[#NotesT1|notes]])}}:
  
 
{|class=wikitable
 
{|class=wikitable
−
!expression||return type||effects||precondition||postcondition
+
!colspan=2|Statement
 +
!Effects
 +
!colspan=2|{{nbsp|4}}Conditions<ref>For an expression whose effect is equivalent to some other operations, the conditions of the expressions inside those operations are inherited on top of the conditions listed in the table.</ref>
 
|-
 
|-
−
|{{c|X(n,t)}}|| ||Constructs a {{ttb|SequenceContainer}} containing {{ttb|n}} copies of {{ttb|t}} || T {{concept|CopyInsertable}} || {{c|std::distance(begin(),end()) {{==}} n}}
+
|rowspan=2 colspan=2|{{c|X u(n, t)}}
 +
|rowspan=2|Constructs the sequence container holding {{c|n}} copies of {{c|t}}
 +
|Pre
 +
|{{tt|T}} is {{named req|CopyInsertable}} into {{tt|X}}
 
|-
 
|-
−
|{{c|X(i,j)}}|| ||Constructs a {{ttb|SequenceContainer}} equivalent to the range {{tt|[i,j)}}
+
|Post{{nbsp}}
 +
|{{c multi|std::distance(u.begin(), u.end())
 +
|    {{==}} n}}
 +
|-
 +
|rowspan=2 colspan=2|{{c|X u(i, j)}}
 +
|rowspan=2|Constructs the sequence container equal, element-wise, to the range {{range|i|j}}
 +
|Pre
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} from {{c|*i}} into {{tt|X}}
 +
|-
 +
|Post
 +
|{{c multi|std::distance(u.begin(), u.end())
 +
|    {{==}} std::distance(i, j)
 +
}}
 +
|-
 +
!Expression
 +
!Type
 +
!Effects
 +
!colspan=2|Conditions
 +
|-
 +
|rowspan=2|{{c|X(std::from_range, rg)}}<br>{{mark since c++23}}
 +
|rowspan=2|{{tt|X}}
 +
|rowspan=2|Constructs the sequence container equal, element-wise, to the range {{c|rg}}
 +
|Pre
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|*ranges::begin(rg)}}
 +
|-
 +
|Post
 
|
 
|
−
* T {{concept|EmplaceConstructible}}  
+
* Each iterator in the range {{c|rg}} is dereferenced once.
−
* {{mark|only for std::vector}} If the iterators are not {{concept|ForwardIterator}}s, T must be {{concept|CopyInsertable}}
+
* {{c multi|std::distance(begin(), end())
−
|{{c|1=std::distance(begin(),end()) ==  
+
|    {{==}} ranges::distance(rg)}}
−
std::distance(i,j)}}
+
|-
 +
|{{c|X(il)}}<br>{{mark since c++11}}
 +
|{{tt|X}}
 +
|Equivalent to {{c multi|X(il.begin(),
 +
|    il.end())}}
 +
|colspan=2 {{n/a|No explicit requirement}}
 +
|-
 +
|rowspan=2|{{c|1=a = il}}<br>{{mark since c++11}}
 +
|rowspan=2|{{tt|X&}}
 +
|rowspan=2|Assigns the range represented by {{c|il}} into {{c|a}}.<ref>{{lc|std::array}} supports assignment from a braced-init-list, but not from an {{lc|std::initializer_list}}.</ref>
 +
|Pre
 +
|{{tt|T}} is {{named req|CopyInsertable}} and {{named req|CopyAssignable}}
 +
|-
 +
|Post
 +
|Existing elements of {{c|a}} are destroyed or assigned to
 +
|-
 +
|rowspan=2|{{c|a.emplace(p, args)}}<br>{{mark since c++11}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Insert an object of type {{tt|T}}, constructed with {{c|std::forward<Args>(args)}} before {{c|p}}
 +
|Pre
 +
|{{tt|T}} is {{named req|EmplaceConstructible}}
 +
|-
 +
|Post
 +
|The returned iterator points at the element constructed from {{c|args}} into {{c|a}}
 +
|-
 +
|rowspan=2|{{c|a.insert(p, t)}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Inserts a copy of {{c|t}} before {{c|p}}
 +
|Pre
 +
|{{tt|T}} is {{named req|CopyInsertable}}
 +
|-
 +
|Post
 +
|The returned iterator points at the copy of {{c|t}} inserted into {{c|a}}
 +
|-
 +
|rowspan=2|{{c|a.insert(p, rv)}}<br>{{mark since c++11}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Inserts a copy of {{c|rv}} before {{c|p}}, possibly using move semantics
 +
|Pre
 +
|{{tt|T}} is {{named req|MoveInsertable}}
 +
|-
 +
|Post
 +
|The returned iterator points at the copy of {{c|rv}} inserted into {{c|a}}
 +
|-
 +
|rowspan=2|{{c|a.insert(p, n, t)}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Inserts {{c|n}} copies of {{c|t}} before {{c|p}}
 +
|Pre
 +
|{{tt|T}} is {{named req|CopyInsertable}} and {{named req|CopyAssignable}}
 +
|-
 +
|Post
 +
|The returned iterator points at the copy of the first element inserted into {{c|a}} or is {{c|p}} for {{c|1=n == 0}}
 
|-
 
|-
−
|{{c|X(il)}}|| || {{c|X(il.begin(),il.end())}} || ||
+
|rowspan=2|{{c|a.insert(p, i, j)}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Inserts copies of elements in<br>{{range|i|j}} before {{c|p}}
 +
|Pre
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} and {{c|i}} and {{c|j}} are not in {{c|a}}
 
|-
 
|-
−
|{{c|1=a = il}}||{{c|X&}}||Assigns the range represented by {{ttb|il}} into {{ttb|a}}
+
|Post
−
| T {{concept|CopyInsertable}} and {{concept|CopyAssignable}}
+
−
| Existing elements of {{ttb|a}} are destroyed or assigned to
+
−
|-
+
−
|{{c|a.emplace(p,args)}}||iterator
+
−
|Insert an object constructed with {{c|std::forward<Args>(args)}} before {{ttb|p}}
+
 
|
 
|
−
*T {{concept|CopyInsertable}}
+
* Each iterator in {{range|i|j}} is dereferenced once.
−
*{{mark|for std::vector and std::deque}} T {{concept|MoveAssignable}} and {{concept|MoveInsertable}}
+
* The returned iterator points at the copy of the first element inserted into {{c|a}} or is {{c|p}} for {{c|1=i == j}}
 +
|-
 +
|rowspan=2|{{c|a.insert_range(p, rg)}}<br>{{mark since c++23}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Inserts copies of elements in {{c|rg}} before {{c|p}}
 +
|Pre
 
|
 
|
−
|-
+
* {{tt|T}} is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|*ranges::begin(rg)}}
−
|{{c|a.emplace(p,t)}}||iterator
+
* {{c|rg}} and {{c|a}} do not overlap
−
|Inserts a copy of {{ttb|t}} before {{ttb|i}}
+
|-
−
|
+
|Post
−
* T {{concept|CopyInsertable}}
+
−
*{{mark|for std::vector and std::deque}} T {{concept|CopyAssignable}} or {{concept|MoveAssignable}}
+
 
|
 
|
 +
* Each iterator in the range {{c|rg}} is dereferenced once
 +
* The returned iterator points at the copy of the first element inserted into {{c|a}} or at {{c|p}} if {{c|rg}} is empty
 
|-
 
|-
−
|{{c|a.insert(p,n,t)}}||iterator||Inserts {{ttb|n}} copies of {{ttb|t}} before {{ttb|i}}
+
|rowspan=2|{{c|a.insert(p, il)}}<br>{{mark since c++11}}
−
| T {{concept|CopyInsertable}} and {{concept|CopyAssignable}}
+
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Equivalent to {{c multi
 +
|a.insert(p,
 +
|        il.begin(),
 +
|        il.end())
 +
}}
 +
|Pre
 +
|{{n/a|No explicit requirement}}
 +
|-
 +
|Post
 +
|The returned iterator points at the copy of the first element inserted into {{c|a}} or is {{c|p}} if {{c|il}} is empty
 +
|-
 +
|rowspan=2|{{c|a.erase(q)}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Erases the element pointed to by {{c|q}}
 +
|Pre
 +
|{{n/a|No explicit requirement}}
 +
|-
 +
|Post
 +
|The returned iterator points at the element that was immediately following {{c|q}} prior to erasure, or {{c|a.end()}} if no such element exists
 +
|-
 +
|rowspan=2|{{c|a.erase(q1, q2)}}
 +
|rowspan=2|{{tt|iterator}}
 +
|rowspan=2|Erases elements in {{range|q1|q2}}
 +
|Pre
 +
|{{n/a|No explicit requirement}}
 +
|-
 +
|Post
 +
|The returned iterator points at the element that was pointed by {{c|q2}} prior to any erasure, or {{c|a.end()}} if no such element exists
 +
|-
 +
|rowspan=2|{{c|a.clear()}}
 +
|rowspan=2|{{c/core|void}}
 +
|rowspan=2|Destroys all elements in {{c|a}}
 +
|Pre
 +
|{{n/a|No explicit requirement}}
 +
|-
 +
|Post
 
|
 
|
 +
* All references, pointers, and iterators are invalidated, including the end iterator
 +
* {{c|a.empty()}} is {{c|true}}
 
|-
 
|-
−
|{{c|a.insert(p,i,j)}}||iterator||Inserts copies of elements in {{tt|[i, j)}} before {{ttb|p}}
+
|rowspan=2|{{c|a.assign(i, j)}}
 +
|rowspan=2|{{c/core|void}}
 +
|rowspan=2|Replaces elements in {{c|a}} with a copy of {{range|i|j}}
 +
|Pre
 
|
 
|
−
* T {{concept|EmplaceConstructible}}
+
* {{tt|T}} is {{named req|EmplaceConstructible}}
−
* {{mark|only for std::vector}} If the iterators are not {{concept|ForwardIterator}}s, T must be {{concept|MoveInsertable}} and {{concept|MoveAssignable}}
+
* {{c|i}} and {{c|j}} are not in {{c|a}}
−
* {{ttb|i}} and {{ttb|j}} are not in {{ttb|a}}
+
−
|Each iterator in {{tt|[i,j)}} is dereferenced once
+
 
|-
 
|-
−
|{{c|a.insert(p, il)}}||iterator||{{c|a.insert(p,il.begin(),il.end())}}|| ||
+
|Post
 +
|Each iterator in {{range|i|j}} is dereferenced once.
 
|-
 
|-
−
|{{c|a.erase(q)}}||iterator||Erases the element pointed to by q
+
|rowspan=2|{{c|a.assign_range(rg)}}<br>{{mark since c++23}}
−
|{{mark|std::deque, std::vector}} T {{concept|MoveAssignable}}
+
|rowspan=2|{{c/core|void}}
 +
|rowspan=2|Replaces elements in {{c|a}} with a copy of each element in {{c|rg}}
 +
|Pre
 
|
 
|
 +
* {{tt|T}}<ref>{{tt|T}} and {{tt|R}} are types such that {{c/core|std::assignable_from<T&, ranges::range_reference_t<R>>}} is modeled.</ref> is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|*ranges::begin(rg)}}
 +
* {{c|rg}} and {{c|a}} do not overlap.
 
|-
 
|-
−
|{{c|a.erase(p,q)}}||iterator||Erases elements in {{tt|[p,q)}}||{{mark|std::deque, std::vector}} T {{concept|MoveAssignable}}||
+
|Post
 +
|
 +
* Each iterator in the range {{c|rg}} is dereferenced once.
 +
* All references, pointers, and iterators are invalidated.
 
|-
 
|-
−
|{{c|a.clear()}}||void||Destroys all elements in {{ttb|a}}|| ||
+
|{{c|a.assign(il)}}<br>{{mark since c++11}}
−
* All references are invalidated
+
|{{c/core|void}}
−
* {{c|1=a.empty() == true}}
+
|Equivalent to<br>
 +
{{c multi
 +
|a.assign(il.begin(),
 +
|        il.end())}}
 +
|colspan=2 {{n/a|No explicit requirement}}
 
|-
 
|-
−
|{{c|a.assign(i,j)}}||void||Replaces elements in a with a copy of {{tt|[i, j)}}
+
|rowspan=2|{{c|a.assign(n, t)}}
−
|
+
|rowspan=2|{{c/core|void}}
−
* T {{concept|EmplaceConstructible}}
+
|rowspan=2|Replaces elements in {{c|a}} with {{c|n}} copies of {{c|t}}
−
* {{mark|std::vector}} If not {{concept|ForwardIterator}} T {{concept|MoveInsertable}}
+
|Pre
−
* {{ttb|i}}, {{ttb|j}} not in {{ttb|a}}
+
|{{tt|T}} is {{named req|CopyInsertable}} and {{named req|CopyAssignable}}
−
|Each iterator in {{tt|[i,j)}} is dereferenced once
+
 
|-
 
|-
−
|{{c|a.assign(il)}}||void||{{c|a.assign(il.begin(),il.end())}}|| ||
+
|Post
 +
|{{n/a|No explicit requirement}}
 
|-
 
|-
−
|{{c|a.assign(n,t)}}||void
+
!colspan=5|Notes {{anchor|NotesT1}}
−
|Replaces elements in {{ttb|a}} with {{ttb|n}} copies of {{ttb|t}}
+
−
|T {{concept|CopyInsertable}} and {{concept|CopyAssignable}}
+
−
|
+
 
|-
 
|-
 +
|colspan=5|<references/>
 
|}
 
|}
  
−
===Optional Operations===
+
====Optional operations====
−
{{todo}}
+
The following expressions must be valid and have their specified effects for the sequence containers named, all operations {{rev inl|since=c++23|except {{tt|prepend_range}} and {{tt|append_range}}}} take amortized constant time:
  
−
===SequenceContainers in the standard library===
+
{|class=wikitable
 +
!Expression||Type||Effects||{{nbsp|4}}Preconditions<ref>For an expression whose effect is equivalent to some other operations, the preconditions of the expressions inside those operations are inherited on top of the preconditions listed in the table.</ref>||Containers
 +
|-
 +
|{{c|a.front()}}
 +
|{{tt|reference}}, or
 +
{{tt|const_reference}} for {{c/core|const}} {{c|a}}
 +
|Returns {{c|*a.begin()}}
 +
|{{n/a|No explicit requirement}}
 +
|{{lc|std::basic_string}}, {{lc|std::array}}, {{lc|std::deque}}, {{lc|std::forward_list}}, {{lc|std::inplace_vector}}, {{lc|std::list}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a.back()}}
 +
|{{tt|reference}}, or
 +
{{tt|const_reference}} for {{c/core|const}} {{c|a}}
 +
|Equivalent to {{c multi|auto tmp {{=}} a.end();|--tmp;|return *tmp;}}
 +
|{{n/a|No explicit requirement}}
 +
|{{lc|std::basic_string}}, {{lc|std::array}}, {{lc|std::deque}}, {{lc|std::inplace_vector}}, {{lc|std::list}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a.emplace_front(args)}}<br>{{mark since c++11}}
 +
|{{c/core|void}}
 +
|Prepends a {{tt|T}} constructed with {{c multi
 +
|std::forward<Args>
 +
|    (args)...
 +
}}
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|args}}
 +
|{{lc|std::deque}}, {{lc|std::forward_list}}, {{lc|std::list}}
 +
|-
 +
|{{c|a.emplace_back(args)}}<br>{{mark since c++11}}
 +
|{{c/core|void}}
 +
|Appends a {{tt|T}} constructed with {{c multi
 +
|std::forward<Args>
 +
|    (args)...
 +
}}
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|args}}
 +
|{{lc|std::deque}}, {{lc|std::inplace_vector}}, {{lc|std::list}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a.push_front(t)}}
 +
|{{c/core|void}}
 +
|Prepends a copy of {{c|t}}
 +
|{{tt|T}} is {{named req|CopyInsertable}} into {{tt|X}}
 +
|rowspan="2" style="text-align:left;"|{{lc|std::deque}}, {{lc|std::forward_list}}, {{lc|std::list}}
 +
|-
 +
|{{c|a.push_front(rv)}}<br>{{mark since c++11}}
 +
|{{c/core|void}}
 +
|Prepends a copy of {{c|rv}}, possibly using move semantics
 +
|{{tt|T}} is {{named req|MoveInsertable}} into {{tt|X}}
 +
|-
 +
|{{c|a.prepend_range(rg)}}<br>{{mark since c++23}}
 +
|{{c/core|void}}
 +
|Inserts<ref name="range">Insertion order, relative to order of elements in {{c|rg}}, is non-reversing.</ref> copies of elements in {{c|rg}} before {{c|begin()}}, each iterator in {{c|rg}} is dereferenced once
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|*ranges::begin(rg)}}
 +
|{{lc|std::deque}}, {{lc|std::forward_list}}, {{lc|std::list}}
 +
|-
 +
|{{c|a.push_back(t)}}
 +
|{{c/core|void}}
 +
|Appends a copy of {{c|t}}
 +
|{{tt|T}} is {{named req|CopyInsertable}} into {{tt|X}}
 +
|rowspan="2" style="text-align:left;"|{{lc|std::basic_string}}, {{lc|std::deque}}, {{lc|std::inplace_vector}}, {{lc|std::list}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a.push_back(rv)}}<br>{{mark since c++11}}
 +
|{{c/core|void}}
 +
|Appends a copy of {{c|rv}}, possibly using move semantics
 +
|{{tt|T}} is {{named req|MoveInsertable}} into {{tt|X}}
 +
|-
 +
|{{c|a.append_range(rg)}}<br>{{mark since c++23}}
 +
|{{c/core|void}}
 +
|Inserts<ref name="range"/> copies of elements in {{c|rg}} before {{c|end()}} dereferencing each iterator in {{c|rg}} once
 +
|{{tt|T}} is {{named req|EmplaceConstructible}} into {{tt|X}} from {{c|*ranges::begin(rg)}}
 +
|{{lc|std::deque}}, {{lc|std::inplace_vector}}, {{lc|std::list}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a.pop_front()}}
 +
|{{c/core|void}}
 +
|Destroys the first element
 +
|{{c|a.empty()}} is {{c|false}}
 +
|{{lc|std::deque}}, {{lc|std::forward_list}}, {{lc|std::list}}
 +
|-
 +
|{{c|a.pop_back()}}
 +
|{{c/core|void}}
 +
|Destroys the last element
 +
|{{c|a.empty()}} is {{c|false}}
 +
|{{lc|std::basic_string}}, {{lc|std::deque}}, {{lc|std::inplace_vector}}, {{lc|std::list}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a[n]}}
 +
|{{tt|reference}}, or
 +
{{tt|const_reference}} for {{c/core|const}} {{c|a}}
 +
|Returns {{c|*(a.begin() + n)}}
 +
|{{n/a|No explicit requirement}}
 +
|rowspan="2" style="text-align:left;"|{{lc|std::basic_string}}, {{lc|std::array}}, {{lc|std::deque}}, {{lc|std::inplace_vector}}, {{lc|std::vector}}
 +
|-
 +
|{{c|a.at(n)}}
 +
|{{tt|reference}}, or
 +
{{tt|const_reference}} for {{c/core|const}} {{c|a}}
 +
|Returns {{c|*(a.begin() + n)}}, throws {{lc|std::out_of_range}} if {{c|1=n >= size()}}
 +
|{{n/a|No explicit requirement}}
 +
|-
 +
!colspan=5|Notes
 +
|-
 +
|colspan=5|<references/>
 +
|}
 +
 
 +
Additionally, for every sequence container:
 +
* A constructor template that takes two input iterators and the member function template overloads of {{tt|insert}}, {{tt|append}}, {{tt|assign}}, {{tt|replace}} that take two input iterators do not participate in overload resolution if the corresponding template argument does not satisfy {{named req|InputIterator}}.
 +
{{rrev|since=c++17|
 +
* A deduction guide that has either a {{named req|InputIterator}} or an {{tt|Allocator}} template parameter does not participate in overload resolution if the type that does not qualify as an input iterator or an allocator respectively is deduced for that parameter.
 +
}}
 +
 
 +
===Sequence containers in the standard library===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/container/dsc array}}
+
{{dsc inc|cpp/string/dsc basic_string}}
−
{{dsc inc | cpp/container/dsc vector}}
+
{{dsc inc|cpp/container/dsc array}}
−
{{dsc inc | cpp/container/dsc deque}}
+
{{dsc inc|cpp/container/dsc vector}}
−
{{dsc inc | cpp/container/dsc forward_list}}
+
{{dsc inc|cpp/container/dsc inplace_vector}}
−
{{dsc inc | cpp/container/dsc list}}
+
{{dsc inc|cpp/container/dsc deque}}
 +
{{dsc inc|cpp/container/dsc forward_list}}
 +
{{dsc inc|cpp/container/dsc list}}
 
{{dsc end}}
 
{{dsc end}}
  
 
====Trade-offs / usage notes====
 
====Trade-offs / usage notes====
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc|std::array|Fast access but fixed number of elements}}
+
{{dsc|{{lc|std::vector}}|Fast access, but mostly inefficient insertions/deletions.}}
−
{{dsc|std::vector|Fast access but mostly inefficient insertions/deletions}}
+
{{dsc|{{lc|std::inplace_vector}}|Fast access, inplace contiguous storage, but fixed capacity and mostly inefficient insertions/deletions.}}
−
{{dsc|std::list<br/>std::forward_list|Efficient insertion/deletion in the middle of the sequence}}
+
{{dsc|{{lc|std::array}}|Fast access, inplace contiguous storage, but fixed number of elements and no insertion/deletion.}}
−
{{dsc|std::deque|Efficient insertion/deletion at the beginning and at the end of the sequence}}
+
{{dsc|{{lc|std::deque}}|Fast access, efficient insertion/deletion at the beginning/end but not in the middle of the sequence.}}
 +
{{dsc|{{lc|std::list}}<br>{{lc|std::forward_list}}|Efficient insertion/deletion in the middle of the sequence, but mostly linear-time access.}}
 
{{dsc end}}
 
{{dsc end}}
  
−
[[de:cpp/concept/SequenceContainer]]
+
===Defect reports===
−
[[es:cpp/concept/SequenceContainer]]
+
{{dr list begin}}
−
[[fr:cpp/concept/SequenceContainer]]
+
{{dr list item|wg=lwg|dr=139|std=C++98|before=the optional operations were not required to<br>be implemented for the designated containers|after=required with<br>amortized time}}
−
[[it:cpp/concept/SequenceContainer]]
+
{{dr list item|wg=lwg|dr=149|std=C++98|before={{c|a.insert(p, t)}} returned {{tt|iterator}} while<br>{{c|a.insert(p, n, t)}} and {{c|a.insert(p, n, t)}} returned {{c/core|void}}|after=they all return<br>{{tt|iterator}}}}
−
[[ja:cpp/concept/SequenceContainer]]
+
{{dr list item|wg=lwg|dr=151|std=C++98|before={{c|q1}} was required to be dereferenceable<ref>It is a defect because it makes the behavior of {{c|a.erase(a.begin(), a.end())}} undefined is {{c|a}} is an empty container.</ref>|after=it can be non-dereferenceable}}
−
[[pt:cpp/concept/SequenceContainer]]
+
{{dr list item|wg=lwg|dr=355|std=C++98|before=calling {{c|a.back()}} or {{c|a.pop_back()}} would<br>execute {{c|--a.end()}}, which is dangerous<ref>If the type of {{c|a.end()}} is a fundamental type, {{c|--a.end()}} is ill-formed. It is dangerous when the type of {{c|a}} is templated, in this case this bug can be difficult to be found.</ref>|after=decrements a copy<br>of {{c|a.end()}} instead}}
−
[[ru:cpp/concept/SequenceContainer]]
+
{{dr list item|wg=lwg|dr=589|std=C++98|before=the elements that {{c|i}} and {{c|j}} refer to<br>might not be convertible to {{tt|value_type}}|after=they are implicitly<br>convertible to {{tt|value_type}}}}
−
[[zh:cpp/concept/SequenceContainer]]
+
{{dr list item|wg=lwg|dr=2194|std=C++11|before={{lc|std::queue}}, {{lc|std::priority_queue}} and<br>{{lc|std::stack}} were also {{named req/core|SequenceContainer}}s<ref>They were not documented as {{named req/core|SequenceContainer}}s in C++98.</ref>|after=they are not {{named req/core|SequenceContainer}}s}}
 +
{{dr list item|wg=lwg|dr=3927|std=C++98|before={{c/core|operator[]}} had no implicit requirement|after=added the implicit requirement}}
 +
{{dr list end}}
 +
<references/>
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 00:50, 12 November 2024

 
C++
 
C++ named requirements
 

A SequenceContainer is a Container that stores objects of the same type in a linear arrangement.

Contents

[edit] Requirements

Legend
X A sequence container class
T The element type of X
a A value of type X
u The name of a declared variable
A The allocator type of X:
i, j LegacyInputIterators such that [i, j) is a valid range and that the iterators refer to elements implicitly convertible to value_type
rg (since C++23) A value of a type R that models container-compatible-range<T>
il (since C++11) An object of type std::initializer_list<value_type>
n A value of type X::size_type
p A valid const iterator into a
q A valid dereferenceable const iterator into a
q1, q2 Two const iterators into a such that [q1, q2) is a valid range
t An lvalue or const rvalue(since C++11) of type X::value_type
rv (since C++11) A non-const rvalue of type X::value_type
Args (since C++11) A template parameter pack
args (since C++11) A function parameter pack with the pattern Arg&&

The type X satisfies SequenceContainer if

  • The type X satisfies Container, and
  • The following statements and expressions must be valid and have their specified effects for all sequence containers except std::array (see notes)(since C++11):
Statement Effects     Conditions[1]
X u(n, t) Constructs the sequence container holding n copies of t Pre T is CopyInsertable into X
Post  std::distance(u.begin(), u.end())
    == n
X u(i, j) Constructs the sequence container equal, element-wise, to the range [i, j) Pre T is EmplaceConstructible from *i into X
Post std::distance(u.begin(), u.end())
    == std::distance(i, j)
Expression Type Effects Conditions
X(std::from_range, rg)
(since C++23) 		X Constructs the sequence container equal, element-wise, to the range rg Pre T is EmplaceConstructible into X from *ranges::begin(rg)
Post
X(il)
(since C++11) 		X Equivalent to X(il.begin(),
    il.end()) 		No explicit requirement
a = il
(since C++11) 		X& Assigns the range represented by il into a.[2] Pre T is CopyInsertable and CopyAssignable
Post Existing elements of a are destroyed or assigned to
a.emplace(p, args)
(since C++11) 		iterator Insert an object of type T, constructed with std::forward<Args>(args) before p Pre T is EmplaceConstructible
Post The returned iterator points at the element constructed from args into a
a.insert(p, t) iterator Inserts a copy of t before p Pre T is CopyInsertable
Post The returned iterator points at the copy of t inserted into a
a.insert(p, rv)
(since C++11) 		iterator Inserts a copy of rv before p, possibly using move semantics Pre T is MoveInsertable
Post The returned iterator points at the copy of rv inserted into a
a.insert(p, n, t) iterator Inserts n copies of t before p Pre T is CopyInsertable and CopyAssignable
Post The returned iterator points at the copy of the first element inserted into a or is p for n == 0
a.insert(p, i, j) iterator Inserts copies of elements in
[i, j) before p 		Pre T is EmplaceConstructible and i and j are not in a
Post
  • Each iterator in [i, j) is dereferenced once.
  • The returned iterator points at the copy of the first element inserted into a or is p for i == j
a.insert_range(p, rg)
(since C++23) 		iterator Inserts copies of elements in rg before p Pre
Post
  • Each iterator in the range rg is dereferenced once
  • The returned iterator points at the copy of the first element inserted into a or at p if rg is empty
a.insert(p, il)
(since C++11) 		iterator Equivalent to a.insert(p,
         il.begin(),
         il.end()) 		Pre No explicit requirement
Post The returned iterator points at the copy of the first element inserted into a or is p if il is empty
a.erase(q) iterator Erases the element pointed to by q Pre No explicit requirement
Post The returned iterator points at the element that was immediately following q prior to erasure, or a.end() if no such element exists
a.erase(q1, q2) iterator Erases elements in [q1, q2) Pre No explicit requirement
Post The returned iterator points at the element that was pointed by q2 prior to any erasure, or a.end() if no such element exists
a.clear() void Destroys all elements in a Pre No explicit requirement
Post
  • All references, pointers, and iterators are invalidated, including the end iterator
  • a.empty() is true
a.assign(i, j) void Replaces elements in a with a copy of [i, j) Pre
Post Each iterator in [i, j) is dereferenced once.
a.assign_range(rg)
(since C++23) 		void Replaces elements in a with a copy of each element in rg Pre
Post
  • Each iterator in the range rg is dereferenced once.
  • All references, pointers, and iterators are invalidated.
a.assign(il)
(since C++11) 		void Equivalent to

a.assign(il.begin(),
         il.end())

No explicit requirement
a.assign(n, t) void Replaces elements in a with n copies of t Pre T is CopyInsertable and CopyAssignable
Post No explicit requirement
Notes
  1. ↑ For an expression whose effect is equivalent to some other operations, the conditions of the expressions inside those operations are inherited on top of the conditions listed in the table.
  2. ↑ std::array supports assignment from a braced-init-list, but not from an std::initializer_list.
  3. ↑ T and R are types such that std::assignable_from<T&, ranges::range_reference_t<R>> is modeled.

[edit] Optional operations

The following expressions must be valid and have their specified effects for the sequence containers named, all operations except prepend_range and append_range(since C++23) take amortized constant time:

Expression Type Effects     Preconditions[1] Containers
a.front() reference, or

const_reference for const a

Returns *a.begin() No explicit requirement std::basic_string, std::array, std::deque, std::forward_list, std::inplace_vector, std::list, std::vector
a.back() reference, or

const_reference for const a

Equivalent to auto tmp = a.end();
--tmp;
return *tmp; 		No explicit requirement std::basic_string, std::array, std::deque, std::inplace_vector, std::list, std::vector
a.emplace_front(args)
(since C++11) 		void Prepends a T constructed with std::forward<Args>
    (args)... 		T is EmplaceConstructible into X from args std::deque, std::forward_list, std::list
a.emplace_back(args)
(since C++11) 		void Appends a T constructed with std::forward<Args>
    (args)... 		T is EmplaceConstructible into X from args std::deque, std::inplace_vector, std::list, std::vector
a.push_front(t) void Prepends a copy of t T is CopyInsertable into X std::deque, std::forward_list, std::list
a.push_front(rv)
(since C++11) 		void Prepends a copy of rv, possibly using move semantics T is MoveInsertable into X
a.prepend_range(rg)
(since C++23) 		void Inserts[2] copies of elements in rg before begin(), each iterator in rg is dereferenced once T is EmplaceConstructible into X from *ranges::begin(rg) std::deque, std::forward_list, std::list
a.push_back(t) void Appends a copy of t T is CopyInsertable into X std::basic_string, std::deque, std::inplace_vector, std::list, std::vector
a.push_back(rv)
(since C++11) 		void Appends a copy of rv, possibly using move semantics T is MoveInsertable into X
a.append_range(rg)
(since C++23) 		void Inserts[2] copies of elements in rg before end() dereferencing each iterator in rg once T is EmplaceConstructible into X from *ranges::begin(rg) std::deque, std::inplace_vector, std::list, std::vector
a.pop_front() void Destroys the first element a.empty() is false std::deque, std::forward_list, std::list
a.pop_back() void Destroys the last element a.empty() is false std::basic_string, std::deque, std::inplace_vector, std::list, std::vector
a[n] reference, or

const_reference for const a

Returns *(a.begin() + n) No explicit requirement std::basic_string, std::array, std::deque, std::inplace_vector, std::vector
a.at(n) reference, or

const_reference for const a

Returns *(a.begin() + n), throws std::out_of_range if n >= size() No explicit requirement
Notes
  1. ↑ For an expression whose effect is equivalent to some other operations, the preconditions of the expressions inside those operations are inherited on top of the preconditions listed in the table.
  2. ↑ 2.0 2.1 Insertion order, relative to order of elements in rg, is non-reversing.

Additionally, for every sequence container:

  • A constructor template that takes two input iterators and the member function template overloads of insert, append, assign, replace that take two input iterators do not participate in overload resolution if the corresponding template argument does not satisfy LegacyInputIterator.
  • A deduction guide that has either a LegacyInputIterator or an Allocator template parameter does not participate in overload resolution if the type that does not qualify as an input iterator or an allocator respectively is deduced for that parameter.
(since C++17)

[edit] Sequence containers in the standard library

 stores and manipulates sequences of characters
(class template) [edit]
(C++11)
 fixed-sized inplace contiguous array
(class template) [edit]
dynamic contiguous array
(class template) [edit]
(C++26)
 dynamically-resizable, fixed capacity, inplace contiguous array
(class template) [edit]
double-ended queue
(class template) [edit]
(C++11)
 singly-linked list
(class template) [edit]
doubly-linked list
(class template) [edit]

[edit] Trade-offs / usage notes

std::vector Fast access, but mostly inefficient insertions/deletions.
std::inplace_vector Fast access, inplace contiguous storage, but fixed capacity and mostly inefficient insertions/deletions.
std::array Fast access, inplace contiguous storage, but fixed number of elements and no insertion/deletion.
std::deque Fast access, efficient insertion/deletion at the beginning/end but not in the middle of the sequence.
std::list
std::forward_list 		Efficient insertion/deletion in the middle of the sequence, but mostly linear-time access.

[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 139 C++98 the optional operations were not required to
be implemented for the designated containers 		required with
amortized time
LWG 149 C++98 a.insert(p, t) returned iterator while
a.insert(p, n, t) and a.insert(p, n, t) returned void 		they all return
iterator
LWG 151 C++98 q1 was required to be dereferenceable[1] it can be non-dereferenceable
LWG 355 C++98 calling a.back() or a.pop_back() would
execute --a.end(), which is dangerous[2] 		decrements a copy
of a.end() instead
LWG 589 C++98 the elements that i and j refer to
might not be convertible to value_type 		they are implicitly
convertible to value_type
LWG 2194 C++11 std::queue, std::priority_queue and
std::stack were also SequenceContainers[3] 		they are not SequenceContainers
LWG 3927 C++98 operator[] had no implicit requirement added the implicit requirement
  1. ↑ It is a defect because it makes the behavior of a.erase(a.begin(), a.end()) undefined is a is an empty container.
  2. ↑ If the type of a.end() is a fundamental type, --a.end() is ill-formed. It is dangerous when the type of a is templated, in this case this bug can be difficult to be found.
  3. ↑ They were not documented as SequenceContainers in C++98.
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/named_req/SequenceContainer&oldid=177614"