Author: | Toon Knapen, David Abrahams, Roland Richter, Jeremy Siek |
---|---|
Contact: | dave@boost-consulting.com, jsiek@osl.iu.edu |
Organization: | Boost Consulting, Indiana University Open Systems Lab |
Date: | 2003-08-05 |
Copyright: | Copyright Toon Knapen, Dave Abrahams, Roland Richter, and Jeremy Siek 2003. All rights reserved |
abstract: |
---|
The permutation iterator adaptor provides a permuted view of a given range. That is, the view includes every element of the given range but in a potentially different order.
The adaptor takes two arguments:
- an iterator to the range V on which the permutation will be applied
- the reindexing scheme that defines how the elements of V will be permuted.
Note that the permutation iterator is not limited to strict permutations of the given range V. The distance between begin and end of the reindexing iterators is allowed to be smaller compared to the size of the range V, in which case the permutation iterator only provides a permutation of a subrange of V. The indexes neither need to be unique. In this same context, it must be noted that the past the end permutation iterator is completely defined by means of the past-the-end iterator to the indices.
template< class ElementIterator , class IndexIterator , class ValueT = use_default , class CategoryT = use_default , class ReferenceT = use_default , class DifferenceT = use_default > class permutation_iterator : public iterator_adaptor<...> { typedef iterator_adaptor<...> friend class iterator_core_access; public: permutation_iterator(); explicit permutation_iterator(ElementIterator x, IndexIterator y); template< class OEIter, class OIIter, class V, class C, class R, class D > permutation_iterator( permutation_iterator<OEIter, OIIter, V, C, R, D> const& r , typename enable_if_convertible<OEIter, ElementIterator>::type* = 0 , typename enable_if_convertible<OIIter, IndexIterator>::type* = 0 ); };
ElementIterator must be a model of RandomAccessIterator. IndexIterator must at least be a model ForwardIterator. The value type of the IndexIterator must be convertible to the difference type of ElementIterator.
The permutation iterator implements the member functions and operators required for the Random Access Iterator concept. However, the permutation iterator can only meet the complexity guarantees of the same concept as the IndexIterator. Thus for instance, although the permutation iterator provides operator+=(distance), this operation will take linear time in case the IndexIterator is a model of ForwardIterator instead of amortized constant time.