libs/compute/doc/html/boost/compute/permutation_iterator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template permutation_iterator</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.iterator.permutation_iterator_hpp" title="Header &lt;boost/compute/iterator/permutation_iterator.hpp&gt;">
   9 <link rel="prev" href="make_fun_idm46009692177760.html" title="Function template make_function_input_iterator">
  10 <link rel="next" href="make_permutation_iterator.html" title="Function template make_permutation_iterator">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="make_fun_idm46009692177760.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.permutation_iterator_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_permutation_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.permutation_iterator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template permutation_iterator</span></h2>
  29 <p>boost::compute::permutation_iterator &#8212; The <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a> class provides a permuation iterator. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.iterator.permutation_iterator_hpp" title="Header &lt;boost/compute/iterator/permutation_iterator.hpp&gt;">boost/compute/iterator/permutation_iterator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ElementIterator<span class="special">,</span> <span class="keyword">typename</span> IndexIterator<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                 <a name="boost.compute.permutation_iterator.super_type"></a><span class="identifier">super_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">super_type</span><span class="special">::</span><span class="identifier">value_type</span>      <a name="boost.compute.permutation_iterator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">super_type</span><span class="special">::</span><span class="identifier">reference</span>       <a name="boost.compute.permutation_iterator.reference"></a><span class="identifier">reference</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">super_type</span><span class="special">::</span><span class="identifier">base_type</span>       <a name="boost.compute.permutation_iterator.base_type"></a><span class="identifier">base_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">super_type</span><span class="special">::</span><span class="identifier">difference_type</span> <a name="boost.compute.permutation_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">IndexIterator</span>               <a name="boost.compute.permutation_iterator.index_iterator"></a><span class="identifier">index_iterator</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="permutation_iterator.html#boost.compute.permutation_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
  46   <a class="link" href="permutation_iterator.html#idm46009692150528-bb"><span class="identifier">permutation_iterator</span></a><span class="special">(</span><span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="permutation_iterator.html#idm46009692148864-bb"><span class="identifier">permutation_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a><span class="special">&lt;</span> <span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a><span class="special">&lt;</span> <span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  49   <a class="link" href="permutation_iterator.html#idm46009692147424-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a><span class="special">&lt;</span> <span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="permutation_iterator.html#idm46009692145392-bb"><span class="special">~</span><span class="identifier">permutation_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51
  52   <span class="comment">// <a class="link" href="permutation_iterator.html#idm46009692156272-bb">public member functions</a></span>
  53   <span class="identifier">size_t</span> <a class="link" href="permutation_iterator.html#idm46009692155712-bb"><span class="identifier">get_index</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&amp;</span> <a class="link" href="permutation_iterator.html#idm46009692154592-bb"><span class="identifier">get_buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IndexExpr<span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="permutation_iterator.html#idm46009692153472-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">IndexExpr</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56
  57   <span class="comment">// <a class="link" href="permutation_iterator.html#idm46009692145104-bb">private member functions</a></span>
  58   <span class="identifier">reference</span> <a class="link" href="permutation_iterator.html#idm46009692144528-bb"><span class="identifier">dereference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59 <span class="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="idm46113318707296"></a><h2>Description</h2>
  62 <p>A permutation iterator iterates over a value range and an index range. When dereferenced, it returns the value from the value range using the current index from the index range.</p>
  63 <p>For example, to reverse a range using the copy() algorithm and a permutation sequence:</p>
  64 <pre class="programlisting"></pre>
  65 <p> </p>
  66 <p><span class="bold"><strong>See Also:</strong></span></p>
  67 <p>make_permutation_iterator() </p>
  68 <p>
  69 </p>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="idm46113318704176"></a><h3>
  74 <a name="boost.compute.permutation_iteratorconstruct-copy-destruct"></a><code class="computeroutput">permutation_iterator</code>
  75         public
  76        construct/copy/destruct</h3>
  77 <div class="orderedlist"><ol class="orderedlist" type="1">
  78 <li class="listitem"><pre class="literallayout"><a name="idm46009692150528-bb"></a><span class="identifier">permutation_iterator</span><span class="special">(</span><span class="identifier">ElementIterator</span> e<span class="special">,</span> <span class="identifier">IndexIterator</span> i<span class="special">)</span><span class="special">;</span></pre></li>
  79 <li class="listitem"><pre class="literallayout"><a name="idm46009692148864-bb"></a><span class="identifier">permutation_iterator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a><span class="special">&lt;</span> <span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  80 <li class="listitem"><pre class="literallayout"><a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a><span class="special">&lt;</span> <span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  81 <a name="idm46009692147424-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="permutation_iterator.html" title="Class template permutation_iterator">permutation_iterator</a><span class="special">&lt;</span> <span class="identifier">ElementIterator</span><span class="special">,</span> <span class="identifier">IndexIterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  82 <li class="listitem"><pre class="literallayout"><a name="idm46009692145392-bb"></a><span class="special">~</span><span class="identifier">permutation_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  83 </ol></div>
  84 </div>
  85 <div class="refsect2">
  86 <a name="idm46113318668672"></a><h3>
  87 <a name="idm46009692156272-bb"></a><code class="computeroutput">permutation_iterator</code> public member functions</h3>
  88 <div class="orderedlist"><ol class="orderedlist" type="1">
  89 <li class="listitem"><pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009692155712-bb"></a><span class="identifier">get_index</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  90 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&amp;</span> <a name="idm46009692154592-bb"></a><span class="identifier">get_buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  91 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IndexExpr<span class="special">&gt;</span>
  92   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm46009692153472-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">IndexExpr</span> <span class="special">&amp;</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  93 </ol></div>
  94 </div>
  95 <div class="refsect2">
  96 <a name="idm46113318644288"></a><h3>
  97 <a name="idm46009692145104-bb"></a><code class="computeroutput">permutation_iterator</code> private member functions</h3>
  98 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009692144528-bb"></a><span class="identifier">dereference</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div>
  99 </div>
 100 </div>
 101 </div>
 102 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 103 <td align="left"></td>
 104 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 105         Distributed under the Boost Software License, Version 1.0. (See accompanying
 106         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 107       </p>
 108 </div></td>
 109 </tr></table>
 110 <hr>
 111 <div class="spirit-nav">
 112 <a accesskey="p" href="make_fun_idm46009692177760.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.permutation_iterator_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_permutation_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 113 </div>
 114 </body>
 115 </html>