Back to Arangodb

Single Pass Iterator Concept

3rdParty/boost/1.78.0/libs/iterator/doc/SinglePassIterator.rst

3.12.9.12.2 KB
Original Source

.. Copyright David Abrahams 2006. Distributed under the Boost .. Software License, Version 1.0. (See accompanying .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Single Pass Iterator Concept ............................

A class or built-in type X models the Single Pass Iterator concept if the following expressions are valid and respect the stated semantics.

+------------------------------------------------------------------------------------------+ |Single Pass Iterator Requirements (in addition to Incrementable Iterator and Equality | |Comparable) | +--------------------------------+-----------------------------+---------------------------+ |Expression |Return Type |Assertion/Semantics / | | | |Pre-/Post-condition | +================================+=============================+===========================+ |++r |X& |pre: r is | | | |dereferenceable; post: | | | |r is dereferenceable or| | | |r is past-the-end | +--------------------------------+-----------------------------+---------------------------+ |a == b |convertible to bool |== is an equivalence | | | |relation over its domain | +--------------------------------+-----------------------------+---------------------------+ |a != b |convertible to bool |!(a == b) | +--------------------------------+-----------------------------+---------------------------+ |iterator_traversal<X>::type |Convertible to | | | |single_pass_traversal_tag| | +--------------------------------+-----------------------------+---------------------------+