mirror of
https://github.com/boostorg/iterator.git
synced 2025-05-11 05:23:52 +00:00
66 lines
2.2 KiB
ReStructuredText
66 lines
2.2 KiB
ReStructuredText
.. parsed-literal::
|
|
|
|
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:
|
|
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
|
|
);
|
|
};
|
|
|
|
template <class ElementIterator, class IndexIterator>
|
|
permutation_iterator<ElementIterator, IndexIterator>
|
|
make_permutation_iterator( ElementIterator e, IndexIterator i);
|
|
|
|
|
|
|
|
``permutation_iterator`` requirements
|
|
-------------------------------------
|
|
|
|
``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``.
|
|
|
|
__ http://www.sgi.com/tech/stl/RandomAccessIterator.html
|
|
|
|
__ http://www.sgi.com/tech/stl/ForwardIterator.html
|
|
|
|
|
|
|
|
|
|
``permutation_iterator`` operations
|
|
-----------------------------------
|
|
|
|
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.
|
|
|
|
__ http://www.sgi.com/tech/stl/RandomAccessIterator.html
|
|
|
|
|
|
::
|
|
|
|
template <class ElementIterator, class IndexIterator>
|
|
permutation_iterator<ElementIterator, IndexIterator>
|
|
make_permutation_iterator(ElementIterator e, IndexIterator i);
|
|
|
|
:Returns: An instance of ``permutation_iterator<ElementIterator, IndexIterator>``
|
|
that views the range of elements starting at ``e` in the order given
|
|
by ``i``. |