Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | named req
m (s/accidently/accidentally)
m (→‎Methods and operators: fmt)
Line 34: Line 34:
 
!expression||return type||semantics||conditions||complexity
 
!expression||return type||semantics||conditions||complexity
 
|-
 
|-
−
|{{c|C()}}||C||creates an empty container|| Post: C().empty() == true||Constant
+
|{{c|C()}}||C||creates an empty container|| Post: {{tt|1=C().empty() == true}}||Constant
 
|-
 
|-
−
|{{c|C(a)}}||C||creates a copy of {{ttb|a}}||Pre: T must be {{named req|CopyInsertable}}<br/>Post: a == C(a)||Linear
+
|{{c|C(a)}}||C||creates a copy of {{ttb|a}}||Pre: T must be {{named req|CopyInsertable}}<br/>Post: {{tt|1=a == C(a)}}||Linear
 
|-
 
|-
−
|{{c|C(rv)}}{{mark since c++11}}||C||moves {{ttb|rv}}||Post: equal to the value rv had before this construction||Constant<ref name="array">Linear for {{lc|std::array}}</ref>
+
|{{c|C(rv)}}<br>{{mark since c++11}}||C||moves {{ttb|rv}}||Post: equal to the value {{ttb|rv}} had before this construction||Constant<ref name="array">Linear for {{lc|std::array}}</ref>
 
|-
 
|-
−
|{{c|a {{=}} b}}||C&||destroys or copy-assigns all elements of {{ttb|a}} from elements of {{ttb|b}}||Post: a == b||Linear
+
|{{c|1=a = b}}||C&||destroys or copy-assigns all elements of {{ttb|a}} from elements of {{ttb|b}}||Post: {{tt|1=a == b}}||Linear
 
|-
 
|-
−
|{{c|a {{=}} rv}}||C&||destroys or move-assigns all elements of {{ttb|a}} from elements of {{ttb|rv}}||Post: if a and rv do not refer the same object, a is equal to the value rv had before this assignment ||Linear
+
|{{c|1=a = rv}}||C&||destroys or move-assigns all elements of {{ttb|a}} from elements of {{ttb|rv}}||Post: if {{ttb|a}} and {{ttb|rv}} do not refer the same object, {{ttb|a}} is equal to the value {{ttb|rv}} had before this assignment||Linear
 
|-
 
|-
−
|{{c|a.~C()}}||void||destroys all elements of {{ttb|a}} and frees all memory||  ||Linear
+
|{{c|a.~C()}}||{{tt|void}}||destroys all elements of {{ttb|a}} and frees all memory||  ||Linear
 
|-
 
|-
−
|{{c|a.begin()}}||(const_)iterator||Iterator to the first element of {{ttb|a}}|| ||Constant
+
|{{c|a.begin()}}||{{tt|(const_)iterator}}||Iterator to the first element of {{ttb|a}}|| ||Constant
 
|-
 
|-
−
|{{c|a.end()}}||(const_)iterator||Iterator to one past the last element of {{ttb|a}}||  ||Constant
+
|{{c|a.end()}}||{{tt|(const_)iterator}}||Iterator to one past the last element of {{ttb|a}}||  ||Constant
 
|-
 
|-
−
|{{c|a.cbegin()}}{{mark since c++11}}||const_iterator||{{c|const_cast<const C&>(a).begin()}}|| ||Constant
+
|{{c|a.cbegin()}}<br>{{mark since c++11}}||{{tt|const_iterator}}||{{c|const_cast<const C&>(a).begin()}}|| ||Constant
 
|-
 
|-
−
|{{c|a.cend()}}{{mark since c++11}}||const_iterator||{{c|const_cast<const C&>(a).end()}}|| ||Constant
+
|{{c|a.cend()}}<br>{{mark since c++11}}||{{tt|const_iterator}}||{{c|const_cast<const C&>(a).end()}}|| ||Constant
 
|-
 
|-
−
|{{c|a {{==}} b}} || convertible to bool || {{rev inl|until=c++14|noborder=true|{{c|1=a.size() == b.size() &&
+
|{{c|1=a == b}} || convertible to {{c|bool}} || {{rev inl|until=c++14|noborder=true|{{c|1=a.size() == b.size() &&
−
std::equal(a.begin(), a.end(), b.begin())}}<br>}}{{rev inl|since=c++14|noborder=true|{{c|std::equal(a.begin(), a.end(), b.begin(), b.end())}}<br>}} ||Pre: T must be {{named req|EqualityComparable}} || Constant<ref>always linear for {{lc|std::forward_list}}</ref> if {{tt|a.size() !{{=}} b.size()}}, linear otherwise<!-- LWG2257 -->
+
std::equal(a.begin(), a.end(), b.begin())}}<br>}}{{rev inl|since=c++14|noborder=true|{{c|std::equal(a.begin(), a.end(), b.begin(), b.end())}}<br>}} ||Pre: {{tt|T}} must be {{named req|EqualityComparable}} || Constant<ref>always linear for {{lc|std::forward_list}}</ref> if {{tt|1=a.size() != b.size()}}, linear otherwise<!-- LWG2257 -->
 
|-
 
|-
−
|{{c|a !{{=}} b}} || convertible to bool || {{c|!(a {{==}} b)}} || || Linear
+
|{{c|1=a != b}} || convertible to {{c|bool}} || {{c|1=!(a == b)}} || || Linear
 
|-
 
|-
−
|{{c|a.swap(b)}} || void || exchanges the values of {{ttb|a}} and {{ttb|b}} ||  
+
|{{c|a.swap(b)}} || {{tt|void}} || exchanges the values of {{ttb|a}} and {{ttb|b}} ||  
 
| Constant<ref name="array">{{mark since c++11}} Linear for {{lc|std::array}}</ref><ref name="should">{{mark until c++11}} Not strictly constant</ref>
 
| Constant<ref name="array">{{mark since c++11}} Linear for {{lc|std::array}}</ref><ref name="should">{{mark until c++11}} Not strictly constant</ref>
 
|-
 
|-
−
|{{c|swap(a, b)}} || void || {{c|a.swap(b)}} || || Constant<ref name="array"/>
+
|{{c|swap(a, b)}} || {{tt|void}} || {{c|a.swap(b)}} || || Constant<ref name="array"/>
 
|-
 
|-
−
|{{c|a.size()}} || size_type || {{c|std::distance(a.begin(), a.end())}} || || Constant<ref name="should" />
+
|{{c|a.size()}} || {{tt|size_type}} || {{c|std::distance(a.begin(), a.end())}} || || Constant<ref name="should" />
 
|-
 
|-
−
|{{c|a.max_size()}} || size_type || {{c|b.size()}} where {{ttb|b}} is the largest possible container || || Constant<ref name="should" />
+
|{{c|a.max_size()}} || {{tt|size_type}} || {{c|b.size()}} where {{ttb|b}} is the largest possible container || || Constant<ref name="should" />
 
|-
 
|-
−
|{{c|a.empty()}} || convertible to bool || {{c|a.begin() {{==}} a.end()}} || || Constant
+
|{{c|a.empty()}} || convertible to {{c|bool}} || {{c|1=a.begin() == a.end()}} || || Constant
 
|-
 
|-
 
!colspan=6|notes
 
!colspan=6|notes
Line 77: Line 77:
 
Given
 
Given
 
* {{tt|i}} and {{tt|j}}, objects of a container's {{tt|iterator}} type,
 
* {{tt|i}} and {{tt|j}}, objects of a container's {{tt|iterator}} type,
−
in the expressions {{c|i {{==}} j}}, {{c|i !{{=}} j}}, {{c|i < j}}, {{c|i <{{=}} j}}, {{c|i >{{=}} j}}, {{c|i > j}}, {{c|i - j}}, either or both may be replaced by an object of the container's {{tt|const_iterator}} type referring to the same element with no change in semantics.
+
in the expressions {{c|1=i == j}}, {{c|1=i != j}}, {{c|i < j}}, {{c|1=i <= j}}, {{c|1=i >= j}}, {{c|i > j}}, {{c|i - j}}, either or both may be replaced by an object of the container's {{tt|const_iterator}} type referring to the same element with no change in semantics.
  
 
===Container data races===
 
===Container data races===

Revision as of 11:43, 23 September 2022

 
C++
 
C++ named requirements
 

A Container is an object used to store other objects and taking care of the management of the memory used by the objects it contains.

Contents

Requirements

  • C container type;
  • T element type;
  • a, b objects of type C.
  • rv a prvalue expression of type C.

Types

name type notes
value_type T Erasable
reference T&
const_reference const T&
iterator iterator pointing to T LegacyForwardIterator
convertible to const_iterator
const_iterator constant iterator pointing to T LegacyForwardIterator
difference_type signed integer must be the same as iterator_traits::difference_type for iterator and const_iterator
size_type unsigned integer large enough to represent all positive values of difference_type

Methods and operators

expression return type semantics conditions complexity
C() C creates an empty container Post: C().empty() == true Constant
C(a) C creates a copy of a Pre: T must be CopyInsertable
Post: a == C(a)		 Linear
C(rv)
(since C++11)		 C moves rv Post: equal to the value rv had before this construction Constant[1]
a = b C& destroys or copy-assigns all elements of a from elements of b Post: a == b Linear
a = rv C& destroys or move-assigns all elements of a from elements of rv Post: if a and rv do not refer the same object, a is equal to the value rv had before this assignment Linear
a.~C() void destroys all elements of a and frees all memory Linear
a.begin() (const_)iterator Iterator to the first element of a Constant
a.end() (const_)iterator Iterator to one past the last element of a Constant
a.cbegin()
(since C++11)		 const_iterator const_cast<const C&>(a).begin() Constant
a.cend()
(since C++11)		 const_iterator const_cast<const C&>(a).end() Constant
a == b convertible to bool a.size() == b.size() &&
std::equal(a.begin(), a.end(), b.begin())
(until C++14)std::equal(a.begin(), a.end(), b.begin(), b.end())
(since C++14) 		Pre: T must be EqualityComparable Constant[2] if a.size() != b.size(), linear otherwise
a != b convertible to bool !(a == b) Linear
a.swap(b) void exchanges the values of a and b Constant[1][3]
swap(a, b) void a.swap(b) Constant[1]
a.size() size_type std::distance(a.begin(), a.end()) Constant[3]
a.max_size() size_type b.size() where b is the largest possible container Constant[3]
a.empty() convertible to bool a.begin() == a.end() Constant
notes
  1. ↑ 1.0 1.1 1.2 Linear for std::array
  2. ↑ always linear for std::forward_list
  3. ↑ 3.0 3.1 3.2 (until C++11) Not strictly constant

Given

  • i and j, objects of a container's iterator type,

in the expressions i == j, i != j, i < j, i <= j, i >= j, i > j, i - j, either or both may be replaced by an object of the container's const_iterator type referring to the same element with no change in semantics.

Container data races

see container thread safety

Other requirements

C
T

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 179 C++98 iterator and const_iterator types might be incomparable required to be comparable
LWG 2263 C++11 resolution of LWG179 was accidentally dropped in C++11 restored
LWG 2839 C++11 self move assignment of standard containers was not allowed allowed but the result is unspecifed

See also

C++ documentation for Containers library
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/named_req/Container&oldid=143700"