1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template constant_buffer_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.constant_buffer_iterator_hpp" title="Header <boost/compute/iterator/constant_buffer_iterator.hpp>"> 9<link rel="prev" href="make_buffer_iterator.html" title="Function template make_buffer_iterator"> 10<link rel="next" href="make_con_idm45549384830528.html" title="Function template make_constant_buffer_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_buffer_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.constant_buffer_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_con_idm45549384830528.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.constant_buffer_iterator"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template constant_buffer_iterator</span></h2> 29<p>boost::compute::constant_buffer_iterator — An iterator for a buffer in the <code class="computeroutput">constant</code> memory space. </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.constant_buffer_iterator_hpp" title="Header <boost/compute/iterator/constant_buffer_iterator.hpp>">boost/compute/iterator/constant_buffer_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="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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_buffer_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_buffer_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_buffer_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> 41 42 <span class="comment">// <a class="link" href="constant_buffer_iterator.html#boost.compute.constant_buffer_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span> 43 <a class="link" href="constant_buffer_iterator.html#idm45549384846144-bb"><span class="identifier">constant_buffer_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44 <a class="link" href="constant_buffer_iterator.html#idm45549384845856-bb"><span class="identifier">constant_buffer_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> 45 <a class="link" href="constant_buffer_iterator.html#idm45549384844192-bb"><span class="identifier">constant_buffer_iterator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> 47 <a class="link" href="constant_buffer_iterator.html#idm45549384842752-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_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 48 <a class="link" href="constant_buffer_iterator.html#idm45549384840720-bb"><span class="special">~</span><span class="identifier">constant_buffer_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 49 50 <span class="comment">// <a class="link" href="constant_buffer_iterator.html#idm45549384855920-bb">public member functions</a></span> 51 <span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&</span> <a class="link" href="constant_buffer_iterator.html#idm45549384855360-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> 52 <span class="identifier">size_t</span> <a class="link" href="constant_buffer_iterator.html#idm45549384854240-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="identifier">T</span> <a class="link" href="constant_buffer_iterator.html#idm45549384853120-bb"><span class="identifier">read</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 <span class="keyword">void</span> <a class="link" href="constant_buffer_iterator.html#idm45549384851312-bb"><span class="identifier">write</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="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 55 <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="constant_buffer_iterator.html#idm45549384849088-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> 56 57 <span class="comment">// <a class="link" href="constant_buffer_iterator.html#idm45549384840432-bb">private member functions</a></span> 58 <span class="identifier">reference</span> <a class="link" href="constant_buffer_iterator.html#idm45549384839856-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="constant_buffer_iterator.html#idm45549384838736-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 60 <span class="keyword">void</span> <a class="link" href="constant_buffer_iterator.html#idm45549384836464-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="constant_buffer_iterator.html#idm45549384835616-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="constant_buffer_iterator.html#idm45549384834768-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> 63 <span class="identifier">difference_type</span> <a class="link" href="constant_buffer_iterator.html#idm45549384833232-bb"><span class="identifier">distance_to</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 64<span class="special">}</span><span class="special">;</span></pre></div> 65<div class="refsect1"> 66<a name="idm45849507940448"></a><h2>Description</h2> 67<p>The <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_iterator</a> class provides an iterator for values in a buffer in the <code class="computeroutput">constant</code> memory space.</p> 68<p>For iterating over values in the <code class="computeroutput">global</code> memory space (the most common case), use the <a class="link" href="buffer_iterator.html" title="Class template buffer_iterator">buffer_iterator</a> class.</p> 69<p><span class="bold"><strong>See Also:</strong></span></p> 70<p><a class="link" href="buffer_iterator.html" title="Class template buffer_iterator">buffer_iterator</a> </p> 71<p> 72</p> 73<p> 74</p> 75<div class="refsect2"> 76<a name="idm45849507934096"></a><h3> 77<a name="boost.compute.constant_buffer_iteratorconstruct-copy-destruct"></a><code class="computeroutput">constant_buffer_iterator</code> 78 public 79 construct/copy/destruct</h3> 80<div class="orderedlist"><ol class="orderedlist" type="1"> 81<li class="listitem"><pre class="literallayout"><a name="idm45549384846144-bb"></a><span class="identifier">constant_buffer_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 82<li class="listitem"><pre class="literallayout"><a name="idm45549384845856-bb"></a><span class="identifier">constant_buffer_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&</span> buffer<span class="special">,</span> <span class="identifier">size_t</span> index<span class="special">)</span><span class="special">;</span></pre></li> 83<li class="listitem"><pre class="literallayout"><a name="idm45549384844192-bb"></a><span class="identifier">constant_buffer_iterator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 84<li class="listitem"><pre class="literallayout"><a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_iterator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> 85<a name="idm45549384842752-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_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 86<li class="listitem"><pre class="literallayout"><a name="idm45549384840720-bb"></a><span class="special">~</span><span class="identifier">constant_buffer_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 87</ol></div> 88</div> 89<div class="refsect2"> 90<a name="idm45849507897200"></a><h3> 91<a name="idm45549384855920-bb"></a><code class="computeroutput">constant_buffer_iterator</code> public member functions</h3> 92<div class="orderedlist"><ol class="orderedlist" type="1"> 93<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">&</span> <a name="idm45549384855360-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> 94<li class="listitem"><pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45549384854240-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> 95<li class="listitem"><pre class="literallayout"><span class="identifier">T</span> <a name="idm45549384853120-bb"></a><span class="identifier">read</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 96<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384851312-bb"></a><span class="identifier">write</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre></li> 97<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="idm45549384849088-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> 98</ol></div> 99</div> 100<div class="refsect2"> 101<a name="idm45849507857984"></a><h3> 102<a name="idm45549384840432-bb"></a><code class="computeroutput">constant_buffer_iterator</code> private member functions</h3> 103<div class="orderedlist"><ol class="orderedlist" type="1"> 104<li class="listitem"><pre class="literallayout"><span class="identifier">reference</span> <a name="idm45549384839856-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> 105<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549384838736-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 106<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384836464-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 107<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384835616-bb"></a><span class="identifier">decrement</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 108<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45549384834768-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> 109<li class="listitem"><pre class="literallayout"><span class="identifier">difference_type</span> <a name="idm45549384833232-bb"></a><span class="identifier">distance_to</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="constant_buffer_iterator.html" title="Class template constant_buffer_iterator">constant_buffer_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> 110</ol></div> 111</div> 112</div> 113</div> 114<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 115<td align="left"></td> 116<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 117 Distributed under the Boost Software License, Version 1.0. (See accompanying 118 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>) 119 </p> 120</div></td> 121</tr></table> 122<hr> 123<div class="spirit-nav"> 124<a accesskey="p" href="make_buffer_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.constant_buffer_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_con_idm45549384830528.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 125</div> 126</body> 127</html> 128
