compute/doc/reference/iterator/permutation_iterator.xml

<?xml version="1.0" encoding="utf-8"?>
<header name="boost/compute/iterator/permutation_iterator.hpp">
  <namespace name="boost">
    <namespace name="compute">
      
      <!-- boost::compute::permutation_iterator<ElementIterator, IndexIterator> -->
      <class name="permutation_iterator">
        <template>
          <template-type-parameter name="ElementIterator"/>
          <template-type-parameter name="IndexIterator"/>
        </template>

        <purpose>A permutation iterator adaptor</purpose>

        <description>
          <para>
            The <code>permutation_iterator</code> class provides an iterator
            which returns the value at a position determined by a separate
            index iterator.
          </para>
          <para>
            See also: <functionname>make_permutation_iterator()</functionname>
          </para>
        </description>
      </class>

      <!-- boost::compute::make_permutation_iterator(e, i) -->
      <function name="make_permutation_iterator">
        <template>
          <template-type-parameter name="ElementIterator"/>
          <template-type-parameter name="IndexIterator"/>
        </template>
        <type><classname>permutation_iterator</classname>&lt;ElementIterator, IndexIterator&gt;</type>
        <parameter name="e">
          <paramtype>ElementIterator</paramtype>
        </parameter>
        <parameter name="i">
          <paramtype>IndexIterator</paramtype>
        </parameter>
        <description>
          <para>
            Returns a new <classname>permutation_iterator</classname> for
            element iterator <code>e</code> and index iterator <code>i</code>.
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>