libs/compute/doc/html/boost/compute/strided_iterator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template strided_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.strided_iterator_hpp" title="Header &lt;boost/compute/iterator/strided_iterator.hpp&gt;">
   9 <link rel="prev" href="make_permutation_iterator.html" title="Function template make_permutation_iterator">
  10 <link rel="next" href="make_strided_iterator.html" title="Function template make_strided_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_permutation_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_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_strided_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.strided_iterator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template strided_iterator</span></h2>
  29 <p>boost::compute::strided_iterator &#8212; An iterator adaptor with adjustable iteration step. </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.strided_iterator_hpp" title="Header &lt;boost/compute/iterator/strided_iterator.hpp&gt;">boost/compute/iterator/strided_iterator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterator<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_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.strided_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.strided_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.strided_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.strided_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.strided_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="strided_iterator.html#boost.compute.strided_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
  45   <a class="link" href="strided_iterator.html#idm46009692117072-bb"><span class="identifier">strided_iterator</span></a><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="strided_iterator.html#idm46009692115408-bb"><span class="identifier">strided_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  48   <a class="link" href="strided_iterator.html#idm46009692113984-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="strided_iterator.html#idm46009692111984-bb"><span class="special">~</span><span class="identifier">strided_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="strided_iterator.html#idm46009692122816-bb">public member functions</a></span>
  52   <span class="identifier">size_t</span> <a class="link" href="strided_iterator.html#idm46009692122256-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>
  53   <span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&amp;</span> <a class="link" href="strided_iterator.html#idm46009692121136-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>
  54   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IndexExpression<span class="special">&gt;</span>
  55     <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="strided_iterator.html#idm46009692120016-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">IndexExpression</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="strided_iterator.html#idm46009692111696-bb">private member functions</a></span>
  58   <span class="identifier">reference</span> <a class="link" href="strided_iterator.html#idm46009692111120-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="keyword">bool</span> <a class="link" href="strided_iterator.html#idm46009692110000-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60   <span class="keyword">void</span> <a class="link" href="strided_iterator.html#idm46009692107744-bb"><span class="identifier">increment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">void</span> <a class="link" href="strided_iterator.html#idm46009692106896-bb"><span class="identifier">decrement</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  62   <span class="keyword">void</span> <a class="link" href="strided_iterator.html#idm46009692106048-bb"><span class="identifier">advance</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">super_type</span><span class="special">::</span><span class="identifier">difference_type</span><span class="special">)</span><span class="special">;</span>
  63   <span class="identifier">difference_type</span> <a class="link" href="strided_iterator.html#idm46009692104496-bb"><span class="identifier">distance_to</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  64 <span class="special">}</span><span class="special">;</span></pre></div>
  65 <div class="refsect1">
  66 <a name="idm46113318449328"></a><h2>Description</h2>
  67 <p>The strided iterator adaptor skips over multiple elements each time it is incremented or decremented.</p>
  68 <p><span class="bold"><strong>See Also:</strong></span></p>
  69 <p><a class="link" href="buffer_iterator.html" title="Class template buffer_iterator">buffer_iterator</a>, make_strided_iterator(), make_strided_iterator_end() </p>
  70 <p>
  71 </p>
  72 <p>
  73 </p>
  74 <div class="refsect2">
  75 <a name="idm46113318446448"></a><h3>
  76 <a name="boost.compute.strided_iteratorconstruct-copy-destruct"></a><code class="computeroutput">strided_iterator</code>
  77         public
  78        construct/copy/destruct</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem"><pre class="literallayout"><a name="idm46009692117072-bb"></a><span class="identifier">strided_iterator</span><span class="special">(</span><span class="identifier">Iterator</span> iterator<span class="special">,</span> <span class="identifier">difference_type</span> stride<span class="special">)</span><span class="special">;</span></pre></li>
  81 <li class="listitem"><pre class="literallayout"><a name="idm46009692115408-bb"></a><span class="identifier">strided_iterator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</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 class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  83 <a name="idm46009692113984-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><a name="idm46009692111984-bb"></a><span class="special">~</span><span class="identifier">strided_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  85 </ol></div>
  86 </div>
  87 <div class="refsect2">
  88 <a name="idm46113318414656"></a><h3>
  89 <a name="idm46009692122816-bb"></a><code class="computeroutput">strided_iterator</code> public member functions</h3>
  90 <div class="orderedlist"><ol class="orderedlist" type="1">
  91 <li class="listitem"><pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009692122256-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>
  92 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&amp;</span> <a name="idm46009692121136-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>
  93 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IndexExpression<span class="special">&gt;</span>
  94   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm46009692120016-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">IndexExpression</span> <span class="special">&amp;</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  95 </ol></div>
  96 </div>
  97 <div class="refsect2">
  98 <a name="idm46113318390272"></a><h3>
  99 <a name="idm46009692111696-bb"></a><code class="computeroutput">strided_iterator</code> private member functions</h3>
 100 <div class="orderedlist"><ol class="orderedlist" type="1">
 101 <li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009692111120-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>
 102 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009692110000-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 103 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009692107744-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 104 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009692106896-bb"></a><span class="identifier">decrement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 105 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009692106048-bb"></a><span class="identifier">advance</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">super_type</span><span class="special">::</span><span class="identifier">difference_type</span> n<span class="special">)</span><span class="special">;</span></pre></li>
 106 <li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm46009692104496-bb"></a><span class="identifier">distance_to</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 107 </ol></div>
 108 </div>
 109 </div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 114         Distributed under the Boost Software License, Version 1.0. (See accompanying
 115         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>)
 116       </p>
 117 </div></td>
 118 </tr></table>
 119 <hr>
 120 <div class="spirit-nav">
 121 <a accesskey="p" href="make_permutation_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_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_strided_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 122 </div>
 123 </body>
 124 </html>