1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template counting_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 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.iterator.counting_iterator_hpp" title="Header <boost/compute/iterator/counting_iterator.hpp>"> 9<link rel="prev" href="make_constant_iterator.html" title="Function template make_constant_iterator"> 10<link rel="next" href="make_counting_iterator.html" title="Function template make_counting_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_constant_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.counting_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_counting_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.counting_iterator"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template counting_iterator</span></h2> 29<p>boost::compute::counting_iterator — The <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a> class implements a counting 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: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.iterator.counting_iterator_hpp" title="Header <boost/compute/iterator/counting_iterator.hpp>">boost/compute/iterator/counting_iterator.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_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.counting_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">reference</span> <a name="boost.compute.counting_iterator.reference"></a><span class="identifier">reference</span><span class="special">;</span> 40 <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.counting_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> 41 42 <span class="comment">// <a class="link" href="counting_iterator.html#boost.compute.counting_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span> 43 <a class="link" href="counting_iterator.html#idm45549384778832-bb"><span class="identifier">counting_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 <a class="link" href="counting_iterator.html#idm45549384777856-bb"><span class="identifier">counting_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> <a class="link" href="counting_iterator.html#idm45549384776432-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="counting_iterator.html#idm45549384774432-bb"><span class="special">~</span><span class="identifier">counting_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 47 48 <span class="comment">// <a class="link" href="counting_iterator.html#idm45549384783456-bb">public member functions</a></span> 49 <span class="identifier">size_t</span> <a class="link" href="counting_iterator.html#idm45549384782896-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> 50 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Expr<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="counting_iterator.html#idm45549384781776-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">Expr</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 51 52 <span class="comment">// <a class="link" href="counting_iterator.html#idm45549384774144-bb">private member functions</a></span> 53 <span class="identifier">reference</span> <a class="link" href="counting_iterator.html#idm45549384773568-bb"><span class="identifier">dereference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 <span class="keyword">bool</span> <a class="link" href="counting_iterator.html#idm45549384772448-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 55 <span class="keyword">void</span> <a class="link" href="counting_iterator.html#idm45549384770192-bb"><span class="identifier">increment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 56 <span class="keyword">void</span> <a class="link" href="counting_iterator.html#idm45549384769344-bb"><span class="identifier">decrement</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 57 <span class="keyword">void</span> <a class="link" href="counting_iterator.html#idm45549384768496-bb"><span class="identifier">advance</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span><span class="special">;</span> 58 <span class="identifier">difference_type</span> <a class="link" href="counting_iterator.html#idm45549384766960-bb"><span class="identifier">distance_to</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <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="idm45849507430160"></a><h2>Description</h2> 62<p>A counting iterator returns an internal value (initialized with <code class="computeroutput">init</code>) which is incremented each time the iterator is incremented.</p> 63<p>For example, this could be used to implement the iota() algorithm in terms of the copy() algorithm by copying from a range of counting iterators:</p> 64<pre class="programlisting"></pre> 65<p> </p> 66<p><span class="bold"><strong>See Also:</strong></span></p> 67<p>make_counting_iterator() </p> 68<p> 69</p> 70<p> 71</p> 72<div class="refsect2"> 73<a name="idm45849507426560"></a><h3> 74<a name="boost.compute.counting_iteratorconstruct-copy-destruct"></a><code class="computeroutput">counting_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="idm45549384778832-bb"></a><span class="identifier">counting_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> init<span class="special">)</span><span class="special">;</span></pre></li> 79<li class="listitem"><pre class="literallayout"><a name="idm45549384777856-bb"></a><span class="identifier">counting_iterator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> 80<li class="listitem"><pre class="literallayout"><a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> <a name="idm45549384776432-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> 81<li class="listitem"><pre class="literallayout"><a name="idm45549384774432-bb"></a><span class="special">~</span><span class="identifier">counting_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 82</ol></div> 83</div> 84<div class="refsect2"> 85<a name="idm45849507398752"></a><h3> 86<a name="idm45549384783456-bb"></a><code class="computeroutput">counting_iterator</code> public member functions</h3> 87<div class="orderedlist"><ol class="orderedlist" type="1"> 88<li class="listitem"><pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45549384782896-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> 89<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Expr<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm45549384781776-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">Expr</span> <span class="special">&</span> expr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 90</ol></div> 91</div> 92<div class="refsect2"> 93<a name="idm45849507382736"></a><h3> 94<a name="idm45549384774144-bb"></a><code class="computeroutput">counting_iterator</code> private member functions</h3> 95<div class="orderedlist"><ol class="orderedlist" type="1"> 96<li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm45549384773568-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> 97<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549384772448-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 98<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384770192-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 99<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384769344-bb"></a><span class="identifier">decrement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 100<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384768496-bb"></a><span class="identifier">advance</span><span class="special">(</span><span class="identifier">difference_type</span> n<span class="special">)</span><span class="special">;</span></pre></li> 101<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm45549384766960-bb"></a><span class="identifier">distance_to</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="counting_iterator.html" title="Class template counting_iterator">counting_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 102</ol></div> 103</div> 104</div> 105</div> 106<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 107<td align="left"></td> 108<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 109 Distributed under the Boost Software License, Version 1.0. (See accompanying 110 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>) 111 </p> 112</div></td> 113</tr></table> 114<hr> 115<div class="spirit-nav"> 116<a accesskey="p" href="make_constant_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.counting_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_counting_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 117</div> 118</body> 119</html> 120
