Namespaces
Variants
Views
Actions

C++ named requirements: LegacyBidirectionalIterator

From cppreference.com
< cpp‎ | named req
 
 
C++ named requirements
Basic
Type properties
Library-Wide
Container
Container Elements
Iterator
LegacyBidirectionalIterator
Stream I/O
Random Numbers
Concurrency
(C++11)

(C++11)
(C++11)
Other
 

A LegacyBidirectionalIterator is a LegacyForwardIterator that can be moved in both directions (i.e. incremented and decremented).

If a LegacyBidirectionalIterator it originates from a Container, then it's value_type is the same as the container's, so dereferencing (*it) obtains the container's value_type.

Contents

[edit] Requirements

The type It satisfies LegacyBidirectionalIterator if

And, given

  • a and b, iterators of type It
  • reference, the type denoted by std::iterator_traits<It>::reference

The following expressions must be valid and have their specified effects

Expression Return Equivalent expression Notes
--a It& Preconditions:
  • a is decrementable (there exists such b that a == ++b)

Postconditions:

  • a is dereferenceable
  • --(++a) == a
  • If --a == --b then a == b
  • a and --a designate the same iterator object
a-- convertible to const It& It temp = a;

--a;

return temp;
*a-- reference

A mutable LegacyBidirectionalIterator is a LegacyBidirectionalIterator that additionally satisfies the LegacyOutputIterator requirements.

[edit] Notes

The begin iterator is not decrementable and the behavior is undefined if --container.begin() is evaluated.

A bidirectional iterator does not have to be dereferenceable to be decrementable (in particular, the end iterator is not dereferenceable but is decrementable)

Concept

For the definition of std::iterator_traits, the following exposition-only concept is defined.

template<class I>

concept __LegacyBidirectionalIterator =
  __LegacyForwardIterator<I> && requires(I i) {
    {  --i } -> std::same_as<I&>;
    {  i-- } -> std::convertible_to<const I&>;
    { *i-- } -> std::same_as<std::iter_reference_t<I>>;

  };

where the exposition-only concept __LegacyForwardIterator is described in LegacyForwardIterator#Concept.

(since C++20)

[edit] See also

specifies that a forward_iterator is a bidirectional iterator, supporting movement backwards
(concept) [edit]
Iterator library provides definitions for iterators, iterator traits, adaptors, and utility functions