1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template zip_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.zip_iterator_hpp" title="Header <boost/compute/iterator/zip_iterator.hpp>"> 9<link rel="prev" href="make_transform_iterator.html" title="Function template make_transform_iterator"> 10<link rel="next" href="make_zip_iterator.html" title="Function template make_zip_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_transform_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.zip_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_zip_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.zip_iterator"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template zip_iterator</span></h2> 29<p>boost::compute::zip_iterator — A zip iterator adaptor. </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.zip_iterator_hpp" title="Header <boost/compute/iterator/zip_iterator.hpp>">boost/compute/iterator/zip_iterator.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IteratorTuple<span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_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.zip_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.zip_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.zip_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">difference_type</span> <a name="boost.compute.zip_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <span class="identifier">IteratorTuple</span> <a name="boost.compute.zip_iterator.iterator_tuple"></a><span class="identifier">iterator_tuple</span><span class="special">;</span> 43 44 <span class="comment">// <a class="link" href="zip_iterator.html#boost.compute.zip_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span> 45 <a class="link" href="zip_iterator.html#idm45549384544496-bb"><span class="identifier">zip_iterator</span></a><span class="special">(</span><span class="identifier">IteratorTuple</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="zip_iterator.html#idm45549384543520-bb"><span class="identifier">zip_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 47 <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</span> <span class="special">></span> <span class="special">&</span> 48 <a class="link" href="zip_iterator.html#idm45549384542096-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 49 <a class="link" href="zip_iterator.html#idm45549384540096-bb"><span class="special">~</span><span class="identifier">zip_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 50 51 <span class="comment">// <a class="link" href="zip_iterator.html#idm45549384549120-bb">public member functions</a></span> 52 <span class="keyword">const</span> <span class="identifier">IteratorTuple</span> <span class="special">&</span> <a class="link" href="zip_iterator.html#idm45549384548560-bb"><span class="identifier">get_iterator_tuple</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IndexExpression<span class="special">></span> 54 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="zip_iterator.html#idm45549384547440-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 55 56 <span class="comment">// <a class="link" href="zip_iterator.html#idm45549384539808-bb">private member functions</a></span> 57 <span class="identifier">reference</span> <a class="link" href="zip_iterator.html#idm45549384539232-bb"><span class="identifier">dereference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 58 <span class="keyword">bool</span> <a class="link" href="zip_iterator.html#idm45549384538112-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</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="keyword">void</span> <a class="link" href="zip_iterator.html#idm45549384535856-bb"><span class="identifier">increment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 60 <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm45549384535008-bb"><span class="identifier">decrement</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 61 <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm45549384534160-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> 62 <span class="identifier">difference_type</span> <a class="link" href="zip_iterator.html#idm45549384532624-bb"><span class="identifier">distance_to</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 63<span class="special">}</span><span class="special">;</span></pre></div> 64<div class="refsect1"> 65<a name="idm45849505949264"></a><h2>Description</h2> 66<p>The <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a> class combines values from multiple input iterators. When dereferenced it returns a tuple containing each value at the current position in each input range.</p> 67<p><span class="bold"><strong>See Also:</strong></span></p> 68<p>make_zip_iterator() </p> 69<p> 70</p> 71<p> 72</p> 73<div class="refsect2"> 74<a name="idm45849505946256"></a><h3> 75<a name="boost.compute.zip_iteratorconstruct-copy-destruct"></a><code class="computeroutput">zip_iterator</code> 76 public 77 construct/copy/destruct</h3> 78<div class="orderedlist"><ol class="orderedlist" type="1"> 79<li class="listitem"><pre class="literallayout"><a name="idm45549384544496-bb"></a><span class="identifier">zip_iterator</span><span class="special">(</span><span class="identifier">IteratorTuple</span> iterators<span class="special">)</span><span class="special">;</span></pre></li> 80<li class="listitem"><pre class="literallayout"><a name="idm45549384543520-bb"></a><span class="identifier">zip_iterator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</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 class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</span> <span class="special">></span> <span class="special">&</span> 82<a name="idm45549384542096-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> 83<li class="listitem"><pre class="literallayout"><a name="idm45549384540096-bb"></a><span class="special">~</span><span class="identifier">zip_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 84</ol></div> 85</div> 86<div class="refsect2"> 87<a name="idm45849505916096"></a><h3> 88<a name="idm45549384549120-bb"></a><code class="computeroutput">zip_iterator</code> public member functions</h3> 89<div class="orderedlist"><ol class="orderedlist" type="1"> 90<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">IteratorTuple</span> <span class="special">&</span> <a name="idm45549384548560-bb"></a><span class="identifier">get_iterator_tuple</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"><</span><span class="keyword">typename</span> IndexExpression<span class="special">></span> 92 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm45549384547440-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">&</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="idm45849505896848"></a><h3> 97<a name="idm45549384539808-bb"></a><code class="computeroutput">zip_iterator</code> private member functions</h3> 98<div class="orderedlist"><ol class="orderedlist" type="1"> 99<li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm45549384539232-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> 100<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549384538112-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</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> 101<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384535856-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 102<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384535008-bb"></a><span class="identifier">decrement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 103<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384534160-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> 104<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm45549384532624-bb"></a><span class="identifier">distance_to</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special"><</span> <span class="identifier">IteratorTuple</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> 105</ol></div> 106</div> 107</div> 108</div> 109<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 110<td align="left"></td> 111<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 112 Distributed under the Boost Software License, Version 1.0. (See accompanying 113 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>) 114 </p> 115</div></td> 116</tr></table> 117<hr> 118<div class="spirit-nav"> 119<a accesskey="p" href="make_transform_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.zip_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_zip_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 120</div> 121</body> 122</html> 123
