On this page
std::bidirectional_iterator
Defined in header <iterator> |
||
|---|---|---|
|
(since C++20) |
The concept bidirectional_iterator refines forward_iterator by adding the ability to move an iterator backward.
Iterator concept determination
Definition of this concept is specified via an exposition-only alias template /*ITER_CONCEPT*/.
In order to determine /*ITER_CONCEPT*/<I>, let ITER_TRAITS<I> denote I if the specialization std::iterator_traits<I> is generated from the primary template, or std::iterator_traits<I> otherwise:
- If
ITER_TRAITS<I>::iterator_conceptis valid and names a type,/*ITER_CONCEPT*/<I>denotes the type. - Otherwise, if
ITER_TRAITS<I>::iterator_categoryis valid and names a type,/*ITER_CONCEPT*/<I>denotes the type. - Otherwise, if
std::iterator_traits<I>is generated from the primary template,/*ITER_CONCEPT*/<I>denotesstd::random_access_iterator_tag. - Otherwise,
/*ITER_CONCEPT*/<I>does not denote a type and results in a substitution failure.
Semantic requirements
A bidirectional iterator r is said to be decrementable if and only if there exists some s such that ++s == r.
std::bidirectional_iterator<I> is modeled only if all the concepts it subsumes are modeled, and given two objects a and b of type I:
- If
ais decrementable,ais in the domain of the expressions--aanda--. - Pre-decrement yields an lvalue that refers to the operand:
std::addressof(--a) == std::addressof(a). - Post-decrement yields the previous value of the operand: if
bool(a == b), thenbool(a-- == b). - Post-decrement and pre-decrement perform the same modification on its operand: If
bool(a == b), then after evaluating botha--and--b,bool(a == b)still holds. - Increment and decrement are inverses of each other:
- If
ais incrementable andbool(a == b), thenbool(--(++a) == b). - If
ais decrementable andbool(a == b), thenbool(++(--a) == b).
Equality preservation
Expressions declared in requires expressions of the standard library concepts are required to be equality-preserving (except where stated otherwise).
Notes
Unlike the LegacyBidirectionalIterator requirements, the bidirectional_iterator concept does not require dereference to return an lvalue.
See also
|
(C++20)
|
specifies that an input_iterator is a forward iterator, supporting equality comparison and multi-pass (concept) |
|
(C++20)
|
specifies that a bidirectional_iterator is a random-access iterator, supporting advancement in constant time and subscripting (concept) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/iterator/bidirectional_iterator