Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / zip_iterator.html
index 963868c..120e1ee 100644 (file)
   <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> 
 
   <span class="comment">// <a class="link" href="zip_iterator.html#boost.compute.zip_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="zip_iterator.html#idm46676580056256-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>
-  <a class="link" href="zip_iterator.html#idm46676580055280-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="zip_iterator.html#idm46009692020192-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>
+  <a class="link" href="zip_iterator.html#idm46009692019216-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
   <a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
-  <a class="link" href="zip_iterator.html#idm46676580053856-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="zip_iterator.html#idm46676580051856-bb"><span class="special">~</span><span class="identifier">zip_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="zip_iterator.html#idm46009692017792-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="zip_iterator.html#idm46009692015792-bb"><span class="special">~</span><span class="identifier">zip_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="zip_iterator.html#idm46676580060880-bb">public member functions</a></span>
-  <span class="keyword">const</span> <span class="identifier">IteratorTuple</span> <span class="special">&amp;</span> <a class="link" href="zip_iterator.html#idm46676580060320-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>
+  <span class="comment">// <a class="link" href="zip_iterator.html#idm46009692024816-bb">public member functions</a></span>
+  <span class="keyword">const</span> <span class="identifier">IteratorTuple</span> <span class="special">&amp;</span> <a class="link" href="zip_iterator.html#idm46009692024256-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>
   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IndexExpression<span class="special">&gt;</span> 
-    <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="zip_iterator.html#idm46676580059200-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>
+    <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="zip_iterator.html#idm46009692023136-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>
 
-  <span class="comment">// <a class="link" href="zip_iterator.html#idm46676580051568-bb">private member functions</a></span>
-  <span class="identifier">reference</span> <a class="link" href="zip_iterator.html#idm46676580050992-bb"><span class="identifier">dereference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="zip_iterator.html#idm46676580049872-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm46676580047616-bb"><span class="identifier">increment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm46676580046768-bb"><span class="identifier">decrement</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm46676580045920-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>
-  <span class="identifier">difference_type</span> <a class="link" href="zip_iterator.html#idm46676580044384-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="zip_iterator.html#idm46009692015504-bb">private member functions</a></span>
+  <span class="identifier">reference</span> <a class="link" href="zip_iterator.html#idm46009692014928-bb"><span class="identifier">dereference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="zip_iterator.html#idm46009692013808-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm46009692011552-bb"><span class="identifier">increment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm46009692010704-bb"><span class="identifier">decrement</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="zip_iterator.html#idm46009692009856-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>
+  <span class="identifier">difference_type</span> <a class="link" href="zip_iterator.html#idm46009692008320-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46094036710160"></a><h2>Description</h2>
+<a name="idm46113317870912"></a><h2>Description</h2>
 <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>
 <p><span class="bold"><strong>See Also:</strong></span></p>
 <p>make_zip_iterator() </p>
 <p>
 </p>
 <div class="refsect2">
-<a name="idm46094036707088"></a><h3>
+<a name="idm46113317867840"></a><h3>
 <a name="boost.compute.zip_iteratorconstruct-copy-destruct"></a><code class="computeroutput">zip_iterator</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><a name="idm46676580056256-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>
-<li class="listitem"><pre class="literallayout"><a name="idm46676580055280-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm46009692020192-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>
+<li class="listitem"><pre class="literallayout"><a name="idm46009692019216-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
 <li class="listitem"><pre class="literallayout"><a class="link" href="zip_iterator.html" title="Class template zip_iterator">zip_iterator</a><span class="special">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
-<a name="idm46676580053856-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm46676580051856-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>
+<a name="idm46009692017792-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">&lt;</span> <span class="identifier">IteratorTuple</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm46009692015792-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>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094036676800"></a><h3>
-<a name="idm46676580060880-bb"></a><code class="computeroutput">zip_iterator</code> public member functions</h3>
+<a name="idm46113317837424"></a><h3>
+<a name="idm46009692024816-bb"></a><code class="computeroutput">zip_iterator</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">IteratorTuple</span> <span class="special">&amp;</span> <a name="idm46676580060320-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>
+<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">IteratorTuple</span> <span class="special">&amp;</span> <a name="idm46009692024256-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>
 <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> 
-  <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm46676580059200-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>
+  <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm46009692023136-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>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094036657552"></a><h3>
-<a name="idm46676580051568-bb"></a><code class="computeroutput">zip_iterator</code> private member functions</h3>
+<a name="idm46113317818048"></a><h3>
+<a name="idm46009692015504-bb"></a><code class="computeroutput">zip_iterator</code> private member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46676580050992-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>
-<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46676580049872-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">&lt;</span> <span class="identifier">IteratorTuple</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>
-<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46676580047616-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46676580046768-bb"></a><span class="identifier">decrement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46676580045920-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>
-<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm46676580044384-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">&lt;</span> <span class="identifier">IteratorTuple</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>
+<li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm46009692014928-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>
+<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009692013808-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">&lt;</span> <span class="identifier">IteratorTuple</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>
+<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009692011552-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009692010704-bb"></a><span class="identifier">decrement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46009692009856-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>
+<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm46009692008320-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">&lt;</span> <span class="identifier">IteratorTuple</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>
 </ol></div>
 </div>
 </div>