24 Containers library [containers]

24.2 Requirements [container.requirements]

24.2.2 General containers [container.requirements.general]

24.2.2.2 Container requirements [container.reqmts]

1
#
A type X meets the container requirements if the following types, statements, and expressions are well-formed and have the specified semantics.
🔗
typename X::value_type
2
#
Result: T
3
#
Preconditions: T is Cpp17Erasable from X (see [container.alloc.reqmts], below).
🔗
typename X::reference
4
#
Result: T&
🔗
typename X::const_reference
5
#
Result: const T&
🔗
typename X::iterator
6
#
Result: A type that meets the forward iterator requirements ([forward.iterators]) with value type T.
The type X​::​iterator is convertible to X​::​const_iterator.
🔗
typename X::const_iterator
7
#
Result: A type that meets the requirements of a constant iterator and those of a forward iterator with value type T.
🔗
typename X::difference_type
8
#
Result: A signed integer type, identical to the difference type of X​::​iterator and X​::​const_iterator.
🔗
typename X::size_type
9
#
Result: An unsigned integer type that can represent any non-negative value of X​::​difference_type.
🔗
X u; X u = X();
10
#
Postconditions: u.empty()
11
#
Complexity: Constant.
🔗
X u(v); X u = v;
12
#
Preconditions: T is Cpp17CopyInsertable into X (see below).
13
#
Postconditions: u == v.
14
#
Complexity: Linear.
🔗
X u(rv); X u = rv;
15
#
Postconditions: u is equal to the value that rv had before this construction.
16
#
Complexity: Linear for array and constant for all other standard containers.
🔗
t = v;
17
#
Result: X&.
18
#
Postconditions: t == v.
19
#
Complexity: Linear.
🔗
t = rv
20
#
Result: X&.
21
#
Effects: All existing elements of t are either move assigned to or destroyed.
22
#
Postconditions: If t and rv do not refer to the same object, t is equal to the value that rv had before this assignment.
23
#
Complexity: Linear.
🔗
a.~X()
24
#
Result: void.
25
#
Effects: Destroys every element of a; any memory obtained is deallocated.
26
#
Complexity: Linear.
🔗
b.begin()
27
#
Result: iterator; const_iterator for constant b.
28
#
Returns: An iterator referring to the first element in the container.
29
#
Complexity: Constant.
🔗
b.end()
30
#
Result: iterator; const_iterator for constant b.
31
#
Returns: An iterator which is the past-the-end value for the container.
32
#
Complexity: Constant.
🔗
b.cbegin()
33
#
Result: const_iterator.
34
#
Returns: const_cast<X const&>(b).begin()
35
#
Complexity: Constant.
🔗
b.cend()
36
#
Result: const_iterator.
37
#
Returns: const_cast<X const&>(b).end()
38
#
Complexity: Constant.
🔗
i <=> j
39
#
Result: strong_ordering.
40
#
Constraints: X​::​iterator meets the random access iterator requirements.
41
#
Complexity: Constant.
🔗
c == b
42
#
Preconditions: T meets the Cpp17EqualityComparable requirements.
43
#
Result: bool.
44
#
Returns: equal(c.begin(), c.end(), b.begin(), b.end())
[Note 1: 
The algorithm equal is defined in [alg.equal].
— end note]
45
#
Complexity: Constant if c.size() != b.size(), linear otherwise.
46
#
Remarks: == is an equivalence relation.
🔗
c != b
47
#
Effects: Equivalent to !(c == b).
🔗
t.swap(s)
48
#
Result: void.
49
#
Effects: Exchanges the contents of t and s.
50
#
Complexity: Linear for array and constant for all other standard containers.
🔗
swap(t, s)
51
#
Effects: Equivalent to t.swap(s).
🔗
c.size()
52
#
Result: size_type.
53
#
Returns: distance(c.begin(), c.end()), i.e., the number of elements in the container.
54
#
Complexity: Constant.
55
#
Remarks: The number of elements is defined by the rules of constructors, inserts, and erases.
🔗
c.max_size()
56
#
Result: size_type.
57
#
Returns: distance(begin(), end()) for the largest possible container.
58
#
Complexity: Constant.
🔗
c.empty()
59
#
Result: bool.
60
#
Returns: c.begin() == c.end()
61
#
Complexity: Constant.
62
#
Remarks: If the container is empty, then c.empty() is true.
63
#
In the expressions i == j i != j i < j i <= j i >= j i > j i <=> j i - j where i and j denote objects of a container's iterator type, 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.
64
#
Unless otherwise specified, all containers defined in this Clause obtain memory using an allocator (see [allocator.requirements]).
[Note 2: 
In particular, containers and iterators do not store references to allocated elements other than through the allocator's pointer type, i.e., as objects of type P or pointer_traits<P>​::​template rebind<unspecified>, where P is allocator_traits<allocator_type>​::​pointer.
— end note]
Copy constructors for these container types obtain an allocator by calling allocator_traits<allocator_type>​::​select_on_container_copy_construction on the allocator belonging to the container being copied.
Move constructors obtain an allocator by move construction from the allocator belonging to the container being moved.
Such move construction of the allocator shall not exit via an exception.
All other constructors for these container types take a const allocator_type& argument.
[Note 3: 
If an invocation of a constructor uses the default value of an optional allocator argument, then the allocator type must support value-initialization.
— end note]
A copy of this allocator is used for any memory allocation and element construction performed, by these constructors and by all member functions, during the lifetime of each container object or until the allocator is replaced.
The allocator may be replaced only via assignment or swap().
Allocator replacement is performed by copy assignment, move assignment, or swapping of the allocator only if
  • (64.1)
    allocator_traits<allocator_type>​::​propagate_on_container_copy_assignment​::​value,
  • (64.2)
    allocator_traits<allocator_type>​::​propagate_on_container_move_assignment​::​value, or
  • (64.3)
    allocator_traits<allocator_type>​::​propagate_on_container_swap​::​value
is true within the implementation of the corresponding container operation.
In all container types defined in this Clause, the member get_allocator() returns a copy of the allocator used to construct the container or, if that allocator has been replaced, a copy of the most recent replacement.
65
#
The expression a.swap(b), for containers a and b of a standard container type other than array, shall exchange the values of a and b without invoking any move, copy, or swap operations on the individual container elements.
Any Compare, Pred, or Hash types belonging to a and b shall meet the Cpp17Swappable requirements and shall be exchanged by calling swap as described in [swappable.requirements].
If allocator_traits<allocator_type>​::​propagate_on_container_swap​::​value is true, then allocator_type shall meet the Cpp17Swappable requirements and the allocators of a and b shall also be exchanged by calling swap as described in [swappable.requirements].
Otherwise, the allocators shall not be swapped, and the behavior is undefined unless a.get_allocator() == b.get_allocator().
Every iterator referring to an element in one container before the swap shall refer to the same element in the other container after the swap.
It is unspecified whether an iterator with value a.end() before the swap will have value b.end() after the swap.
66
#
Unless otherwise specified (see [associative.reqmts.except], [unord.req.except], [deque.modifiers], and [vector.modifiers]) all container types defined in this Clause meet the following additional requirements:
  • (66.1)
    If an exception is thrown by an insert() or emplace() function while inserting a single element, that function has no effects.
  • (66.2)
    If an exception is thrown by a push_back(), push_front(), emplace_back(), or emplace_front() function, that function has no effects.
  • (66.3)
    No erase(), clear(), pop_back() or pop_front() function throws an exception.
  • (66.4)
    No copy constructor or assignment operator of a returned iterator throws an exception.
  • (66.5)
    No swap() function throws an exception.
  • (66.6)
    No swap() function invalidates any references, pointers, or iterators referring to the elements of the containers being swapped.
    [Note 4: 
    The end() iterator does not refer to any element, so it can be invalidated.
    — end note]
67
#
Unless otherwise specified (either explicitly or by defining a function in terms of other functions), invoking a container member function or passing a container as an argument to a library function shall not invalidate iterators to, or change the values of, objects within that container.
68
#
A contiguous container is a container whose member types iterator and const_iterator meet the Cpp17RandomAccessIterator requirements ([random.access.iterators]) and model contiguous_iterator ([iterator.concept.contiguous]).
69
#
The behavior of certain container member functions and deduction guides depends on whether types qualify as input iterators or allocators.
The extent to which an implementation determines that a type cannot be an input iterator is unspecified, except that as a minimum integral types shall not qualify as input iterators.
Likewise, the extent to which an implementation determines that a type cannot be an allocator is unspecified, except that as a minimum a type A shall not qualify as an allocator unless it meets both of the following conditions:
  • (69.1)
    The qualified-id A​::​value_type is valid and denotes a type ([temp.deduct]).
  • (69.2)
    The expression declval<A&>().allocate(size_t{}) is well-formed when treated as an unevaluated operand.