Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.

Multi-Pass Input Iterator

This concept is a refinement of Input Iterator, adding the requirements that the iterator can be used to make multiple passes through a range, and that if it1 == it2 and it1 is dereferenceable then ++it1 == ++it2. The Multi-Pass Input Iterator is very similar to the Forward Iterator. The only difference is that a Forward Iterator requires the reference type to be value_type&, whereas MultiPassInputIterator is like Input Iterator in that the reference type merely has to be convertible to value_type.

Design Notes

comments by Valentin Bonnard:

I think that introducing Multi-Pass Input Iterator isn't the right solution. Do you also want to define Multi-Pass Bidirectionnal Iterator and Multi-Pass Random Access Iterator ? I don't, definitly. It only confuses the issue. The problem lies into the existing hierarchy of iterators, which mixes movabillity, modifiabillity and lvalue-ness, and these are clearly independant.

The terms Forward, Bidirectionnal and Random Access are about movabillity and shouldn't be used to mean anything else. In a completly orthogonal way, iterators can be immutable, mutable, or neither. Lvalueness of iterators is also orthogonal with immutabillity. With these clean concepts, your Multi-Pass Input Iterator is just called a Forward Iterator.

Other translations are:
std::Forward Iterator -> ForwardIterator & Lvalue Iterator
std::Bidirectionnal Iterator -> Bidirectionnal Iterator & Lvalue Iterator
std::Random Access Iterator -> Random Access Iterator & Lvalue Iterator

Note that in practice the only operation not allowed on my Forward Iterator which is allowed on std::Forward Iterator is &*it. I think that &* is rarely needed in generic code.

reply by Jeremy Siek:

The above analysis by Valentin is right on. Of course, there is the problem with backward compatibility. The current STL implementations are based on the old definition of Forward Iterator. The right course of action is to get Forward Iterator, etc. changed in the C++ standard. Once that is done we can drop Multi-Pass Input Iterator.


Valid HTML 4.01 Transitional

Revised 05 December, 2006

Copyright © 2000 Jeremy Siek, Univ.of Notre Dame (jsiek@lsc.nd.edu)

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)