libs/compute/doc/html/boost/compute/constant_iterator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template constant_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.constant_iterator_hpp" title="Header &lt;boost/compute/iterator/constant_iterator.hpp&gt;">
   9 <link rel="prev" href="make_constant__idp49190224.html" title="Function template make_constant_buffer_iterator">
  10 <link rel="next" href="make_constant_iterator.html" title="Function template make_constant_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__idp49190224.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.constant_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_constant_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.constant_iterator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template constant_iterator</span></h2>
  29 <p>boost::compute::constant_iterator &#8212; An iterator with a constant value. </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.constant_iterator_hpp" title="Header &lt;boost/compute/iterator/constant_iterator.hpp&gt;">boost/compute/iterator/constant_iterator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_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.constant_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.constant_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.constant_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="constant_iterator.html#boost.compute.constant_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="constant_iterator.html#idp49211056-bb"><span class="identifier">constant_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="constant_iterator.html#idp49213008-bb"><span class="identifier">constant_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <a class="link" href="constant_iterator.html#idp49214432-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="constant_iterator.html#idp49216432-bb"><span class="special">~</span><span class="identifier">constant_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="constant_iterator.html#idp49209216-bb">public member functions</a></span>
  49   <span class="identifier">size_t</span> <a class="link" href="constant_iterator.html#idp49209776-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="special">}</span><span class="special">;</span></pre></div>
  51 <div class="refsect1">
  52 <a name="idp108141696"></a><h2>Description</h2>
  53 <p>The <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a> class provides an iterator which returns a constant value when dereferenced.</p>
  54 <p>For example, this could be used to implement the fill() algorithm in terms of the copy() algorithm by copying from a range of constant iterators:</p>
  55 <pre class="programlisting"></pre>
  56 <p> </p>
  57 <p><span class="bold"><strong>See Also:</strong></span></p>
  58 <p>make_constant_iterator() </p>
  59 <p>
  60 </p>
  61 <div class="refsect2">
  62 <a name="idp108145424"></a><h3>
  63 <a name="boost.compute.constant_iteratorconstruct-copy-destruct"></a><code class="computeroutput">constant_iterator</code>
  64         public
  65        construct/copy/destruct</h3>
  66 <div class="orderedlist"><ol class="orderedlist" type="1">
  67 <li class="listitem"><pre class="literallayout"><a name="idp49211056-bb"></a><span class="identifier">constant_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">,</span> <span class="identifier">size_t</span> index <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li>
  68 <li class="listitem"><pre class="literallayout"><a name="idp49213008-bb"></a><span class="identifier">constant_iterator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  69 <li class="listitem"><pre class="literallayout"><a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <a name="idp49214432-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_iterator.html" title="Class template constant_iterator">constant_iterator</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  70 <li class="listitem"><pre class="literallayout"><a name="idp49216432-bb"></a><span class="special">~</span><span class="identifier">constant_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  71 </ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idp108179504"></a><h3>
  75 <a name="idp49209216-bb"></a><code class="computeroutput">constant_iterator</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">size_t</span> <a name="idp49209776-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></ol></div>
  77 </div>
  78 </div>
  79 </div>
  80 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  81 <td align="left"></td>
  82 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
  83         Distributed under the Boost Software License, Version 1.0. (See accompanying
  84         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>)
  85       </p>
  86 </div></td>
  87 </tr></table>
  88 <hr>
  89 <div class="spirit-nav">
  90 <a accesskey="p" href="make_constant__idp49190224.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.constant_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_constant_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  91 </div>
  92 </body>
  93 </html>