]> git.proxmox.com Git - ceph.git/blob - ceph/src/boost/libs/iterator/doc/permutation_iterator_body.rst
add subtree-ish sources for 12.0.3
[ceph.git] / ceph / src / boost / libs / iterator / doc / permutation_iterator_body.rst
1 .. Copyright David Abrahams 2006. Distributed under the Boost
2 .. Software License, Version 1.0. (See accompanying
3 .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
4
5 The adaptor takes two arguments:
6
7 * an iterator to the range V on which the permutation
8 will be applied
9 * the reindexing scheme that defines how the
10 elements of V will be permuted.
11
12 Note that the permutation iterator is not limited to strict
13 permutations of the given range V. The distance between begin and end
14 of the reindexing iterators is allowed to be smaller compared to the
15 size of the range V, in which case the permutation iterator only
16 provides a permutation of a subrange of V. The indexes neither need
17 to be unique. In this same context, it must be noted that the past the
18 end permutation iterator is completely defined by means of the
19 past-the-end iterator to the indices.