libs/compute/doc/html/boost/compute/wait_list.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class wait_list</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.utility.wait_list_hpp" title="Header &lt;boost/compute/utility/wait_list.hpp&gt;">
   9 <link rel="prev" href="../../BOOST_CO_idm46009691508864.html" title="Macro BOOST_COMPUTE_STRINGIZE_SOURCE">
  10 <link rel="next" href="../../boost_compute/performance.html" title="Performance">
  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="../../BOOST_CO_idm46009691508864.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.wait_list_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="../../boost_compute/performance.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.wait_list"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class wait_list</span></h2>
  29 <p>boost::compute::wait_list &#8212; Stores a list of events. </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.utility.wait_list_hpp" title="Header &lt;boost/compute/utility/wait_list.hpp&gt;">boost/compute/utility/wait_list.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="wait_list.html" title="Class wait_list">wait_list</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="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">event</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">iterator</span>       <a name="boost.compute.wait_list.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">event</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">const_iterator</span> <a name="boost.compute.wait_list.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="wait_list.html#boost.compute.wait_listconstruct-copy-destruct">construct/copy/destruct</a></span>
  42   <a class="link" href="wait_list.html#idm46009691465248-bb"><span class="identifier">wait_list</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43   <a class="link" href="wait_list.html#idm46009691464656-bb"><span class="identifier">wait_list</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="wait_list.html#idm46009691462928-bb"><span class="identifier">wait_list</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="wait_list.html#idm46009691460752-bb"><span class="identifier">wait_list</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">event</span> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="wait_list.html#idm46009691456240-bb"><span class="identifier">wait_list</span></a><span class="special">(</span><a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span> <a class="link" href="wait_list.html#idm46009691459008-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span> <a class="link" href="wait_list.html#idm46009691454208-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="wait_list.html#idm46009691451168-bb"><span class="special">~</span><span class="identifier">wait_list</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="wait_list.html#idm46009691496064-bb">public member functions</a></span>
  52   <span class="keyword">bool</span> <a class="link" href="wait_list.html#idm46009691495504-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="identifier">uint_</span> <a class="link" href="wait_list.html#idm46009691493632-bb"><span class="identifier">size</span></a><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="wait_list.html#idm46009691492192-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">const</span> <span class="identifier">cl_event</span> <span class="special">*</span> <a class="link" href="wait_list.html#idm46009691491024-bb"><span class="identifier">get_event_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="keyword">void</span> <a class="link" href="wait_list.html#idm46009691488144-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="wait_list.html#idm46009691486272-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="wait_list.html#idm46009691484000-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="future.html" title="Class template future">future</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>
  59   <span class="keyword">void</span> <a class="link" href="wait_list.html#idm46009691480432-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60   <span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&amp;</span> <a class="link" href="wait_list.html#idm46009691478528-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="identifier">event</span> <span class="special">&amp;</span> <a class="link" href="wait_list.html#idm46009691475952-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  62   <span class="identifier">iterator</span> <a class="link" href="wait_list.html#idm46009691473648-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  63   <span class="identifier">const_iterator</span> <a class="link" href="wait_list.html#idm46009691472464-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  64   <span class="identifier">const_iterator</span> <a class="link" href="wait_list.html#idm46009691471008-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  65   <span class="identifier">iterator</span> <a class="link" href="wait_list.html#idm46009691469552-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  66   <span class="identifier">const_iterator</span> <a class="link" href="wait_list.html#idm46009691468352-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  67   <span class="identifier">const_iterator</span> <a class="link" href="wait_list.html#idm46009691466880-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  68 <span class="special">}</span><span class="special">;</span></pre></div>
  69 <div class="refsect1">
  70 <a name="idm46113314735984"></a><h2>Description</h2>
  71 <p>The <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> class stores a set of event objects and can be used to specify dependencies for OpenCL operations or to wait on the host until all of the events have completed.</p>
  72 <p>This class also provides convenience functions for interacting with OpenCL APIs which typically accept event dependencies as a <code class="computeroutput">cl_event*</code> pointer and a <code class="computeroutput">cl_uint</code> size. For example: </p>
  73 <pre class="programlisting"><span class="identifier">wait_list</span> <span class="identifier">events</span> <span class="special">=</span> <span class="special">...</span><span class="special">;</span>
  74
  75 <span class="identifier">clEnqueueNDRangeKernel</span><span class="special">(</span><span class="special">...</span><span class="special">,</span> <span class="identifier">events</span><span class="special">.</span><span class="identifier">get_event_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">events</span><span class="special">.</span><span class="identifier">size</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="special">...</span><span class="special">)</span><span class="special">;</span>
  76 </pre>
  77 <p><span class="bold"><strong>See Also:</strong></span></p>
  78 <p>event, <a class="link" href="future.html" title="Class template future">future&lt;T&gt;</a> </p>
  79 <p>
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idm46113314715984"></a><h3>
  85 <a name="boost.compute.wait_listconstruct-copy-destruct"></a><code class="computeroutput">wait_list</code>
  86         public
  87        construct/copy/destruct</h3>
  88 <div class="orderedlist"><ol class="orderedlist" type="1">
  89 <li class="listitem">
  90 <pre class="literallayout"><a name="idm46009691465248-bb"></a><span class="identifier">wait_list</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Creates an empty wait-list. </li>
  91 <li class="listitem">
  92 <pre class="literallayout"><a name="idm46009691464656-bb"></a><span class="identifier">wait_list</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&amp;</span> event<span class="special">)</span><span class="special">;</span></pre>Creates a wait-list containing <code class="computeroutput">event</code>. </li>
  93 <li class="listitem">
  94 <pre class="literallayout"><a name="idm46009691462928-bb"></a><span class="identifier">wait_list</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new wait-list as a copy of <code class="computeroutput">other</code>. </li>
  95 <li class="listitem">
  96 <pre class="literallayout"><a name="idm46009691460752-bb"></a><span class="identifier">wait_list</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">event</span> <span class="special">&gt;</span> events<span class="special">)</span><span class="special">;</span></pre>Creates a wait-list from <code class="computeroutput">events</code>. </li>
  97 <li class="listitem">
  98 <pre class="literallayout"><a name="idm46009691456240-bb"></a><span class="identifier">wait_list</span><span class="special">(</span><a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Move-constructs a new wait list object from <code class="computeroutput">other</code>. </li>
  99 <li class="listitem">
 100 <pre class="literallayout"><a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span> <a name="idm46009691459008-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the events in the wait-list from <code class="computeroutput">other</code>. </li>
 101 <li class="listitem">
 102 <pre class="literallayout"><a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;</span> <a name="idm46009691454208-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Move-assigns the wait list from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
 103 <li class="listitem">
 104 <pre class="literallayout"><a name="idm46009691451168-bb"></a><span class="special">~</span><span class="identifier">wait_list</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the wait-list. </li>
 105 </ol></div>
 106 </div>
 107 <div class="refsect2">
 108 <a name="idm46113314660896"></a><h3>
 109 <a name="idm46009691496064-bb"></a><code class="computeroutput">wait_list</code> public member functions</h3>
 110 <div class="orderedlist"><ol class="orderedlist" type="1">
 111 <li class="listitem">
 112 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009691495504-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the wait-list is empty. </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="identifier">uint_</span> <a name="idm46009691493632-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of events in the wait-list. </li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691492192-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Removes all of the events from the wait-list. </li>
 117 <li class="listitem">
 118 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">cl_event</span> <span class="special">*</span> <a name="idm46009691491024-bb"></a><span class="identifier">get_event_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 119 <p>Returns a cl_event pointer to the first event in the wait-list. Returns <code class="computeroutput">0</code> if the wait-list is empty.</p>
 120 <p>This can be used to pass the wait-list to OpenCL functions which expect a <code class="computeroutput">cl_event</code> pointer to refer to a list of events. </p>
 121 </li>
 122 <li class="listitem">
 123 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691488144-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_t</span> new_capacity<span class="special">)</span><span class="special">;</span></pre>Reserves a minimum length of storage for the wait list object. </li>
 124 <li class="listitem">
 125 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691486272-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&amp;</span> event<span class="special">)</span><span class="special">;</span></pre>Inserts <code class="computeroutput">event</code> into the wait-list. </li>
 126 <li class="listitem">
 127 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm46009691484000-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="future.html" title="Class template future">future</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> future<span class="special">)</span><span class="special">;</span></pre>Inserts the event from <code class="computeroutput">future</code> into the wait-list. </li>
 128 <li class="listitem">
 129 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691480432-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 130 <p>Blocks until all of the events in the wait-list have completed.</p>
 131 <p>Does nothing if the wait-list is empty. </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&amp;</span> <a name="idm46009691478528-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_t</span> pos<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a reference to the event at specified location <code class="computeroutput">pos</code>. </li>
 135 <li class="listitem">
 136 <pre class="literallayout"><span class="identifier">event</span> <span class="special">&amp;</span> <a name="idm46009691475952-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_t</span> pos<span class="special">)</span><span class="special">;</span></pre>Returns a reference to the event at specified location <code class="computeroutput">pos</code>. </li>
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46009691473648-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the first element of the wait-list. </li>
 139 <li class="listitem">
 140 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691472464-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the first element of the wait-list. </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691471008-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the first element of the wait-list. </li>
 143 <li class="listitem">
 144 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46009691469552-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the element following the last element of the wait-list. </li>
 145 <li class="listitem">
 146 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691468352-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the element following the last element of the wait-list. </li>
 147 <li class="listitem">
 148 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46009691466880-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the element following the last element of the wait-list. </li>
 149 </ol></div>
 150 </div>
 151 </div>
 152 </div>
 153 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 154 <td align="left"></td>
 155 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 156         Distributed under the Boost Software License, Version 1.0. (See accompanying
 157         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>)
 158       </p>
 159 </div></td>
 160 </tr></table>
 161 <hr>
 162 <div class="spirit-nav">
 163 <a accesskey="p" href="../../BOOST_CO_idm46009691508864.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.wait_list_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="../../boost_compute/performance.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 164 </div>
 165 </body>
 166 </html>