1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template future</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.async.future_hpp" title="Header <boost/compute/async/future.hpp>"> 9<link rel="prev" href="pinned_allocator.html" title="Class template pinned_allocator"> 10<link rel="next" href="wait_for_all.html" title="Function template wait_for_all"> 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="pinned_allocator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.async.future_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="wait_for_all.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.future"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template future</span></h2> 29<p>boost::compute::future — Holds the result of an asynchronous computation. </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.async.future_hpp" title="Header <boost/compute/async/future.hpp>">boost/compute/async/future.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="future.html" title="Class template future">future</a> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="future.html#boost.compute.futureconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="future.html#idm45549386365360-bb"><span class="identifier">future</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 39 <a class="link" href="future.html#idm45549386365072-bb"><span class="identifier">future</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="keyword">const</span> <span class="identifier">event</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 40 <a class="link" href="future.html#idm45549386363408-bb"><span class="identifier">future</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"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 41 <a class="link" href="future.html" title="Class template future">future</a> <span class="special">&</span> <a class="link" href="future.html#idm45549386361984-bb"><span class="keyword">operator</span><span class="special">=</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"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 42 <a class="link" href="future.html#idm45549386359984-bb"><span class="special">~</span><span class="identifier">future</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 43 44 <span class="comment">// <a class="link" href="future.html#idm45549386377504-bb">public member functions</a></span> 45 <span class="identifier">T</span> <a class="link" href="future.html#idm45549386376944-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">bool</span> <a class="link" href="future.html#idm45549386375616-bb"><span class="identifier">valid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 47 <span class="keyword">void</span> <a class="link" href="future.html#idm45549386373744-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 48 <span class="identifier">event</span> <a class="link" href="future.html#idm45549386372304-bb"><span class="identifier">get_event</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Function<span class="special">></span> <a class="link" href="future.html" title="Class template future">future</a> <span class="special">&</span> <a class="link" href="future.html#idm45549386370880-bb"><span class="identifier">then</span></a><span class="special">(</span><span class="identifier">Function</span><span class="special">)</span><span class="special">;</span> 50<span class="special">}</span><span class="special">;</span></pre></div> 51<div class="refsect1"> 52<a name="idm45849517474672"></a><h2>Description</h2> 53<p><span class="bold"><strong>See Also:</strong></span></p> 54<p>event, <a class="link" href="wait_list.html" title="Class wait_list">wait_list</a> </p> 55<p> 56</p> 57<p> 58</p> 59<div class="refsect2"> 60<a name="idm45849517472160"></a><h3> 61<a name="boost.compute.futureconstruct-copy-destruct"></a><code class="computeroutput">future</code> 62 public 63 construct/copy/destruct</h3> 64<div class="orderedlist"><ol class="orderedlist" type="1"> 65<li class="listitem"><pre class="literallayout"><a name="idm45549386365360-bb"></a><span class="identifier">future</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 66<li class="listitem"><pre class="literallayout"><a name="idm45549386365072-bb"></a><span class="identifier">future</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> result<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">event</span> <span class="special">&</span> event<span class="special">)</span><span class="special">;</span></pre></li> 67<li class="listitem"><pre class="literallayout"><a name="idm45549386363408-bb"></a><span class="identifier">future</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"><</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> 68<li class="listitem"><pre class="literallayout"><a class="link" href="future.html" title="Class template future">future</a> <span class="special">&</span> <a name="idm45549386361984-bb"></a><span class="keyword">operator</span><span class="special">=</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"><</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> 69<li class="listitem"><pre class="literallayout"><a name="idm45549386359984-bb"></a><span class="special">~</span><span class="identifier">future</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 70</ol></div> 71</div> 72<div class="refsect2"> 73<a name="idm45849517436304"></a><h3> 74<a name="idm45549386377504-bb"></a><code class="computeroutput">future</code> public member functions</h3> 75<div class="orderedlist"><ol class="orderedlist" type="1"> 76<li class="listitem"> 77<pre class="literallayout"><span class="identifier">T</span> <a name="idm45549386376944-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 78<p>Returns the result of the computation. This will block until the result is ready. </p> 79</li> 80<li class="listitem"> 81<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549386375616-bb"></a><span class="identifier">valid</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 future is valid. </li> 82<li class="listitem"> 83<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386373744-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>Blocks until the computation is complete. </li> 84<li class="listitem"> 85<pre class="literallayout"><span class="identifier">event</span> <a name="idm45549386372304-bb"></a><span class="identifier">get_event</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the underlying event object. </li> 86<li class="listitem"> 87<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Function<span class="special">></span> <a class="link" href="future.html" title="Class template future">future</a> <span class="special">&</span> <a name="idm45549386370880-bb"></a><span class="identifier">then</span><span class="special">(</span><span class="identifier">Function</span> callback<span class="special">)</span><span class="special">;</span></pre> 88<p>Invokes a generic callback function once the future is ready.</p> 89<p>The function specified by callback must be invokable with zero arguments.</p> 90<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clSetEventCallback.html" target="_top">clSetEventCallback()</a> for more information. </p> 91<div class="warning"><table border="0" summary="Warning"> 92<tr> 93<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/src/images/warning.png"></td> 94<th align="left">Warning</th> 95</tr> 96<tr><td align="left" valign="top"><p>This method is only available if the OpenCL version is 1.1 or later. </p></td></tr> 97</table></div> 98<p> 99</p> 100</li> 101</ol></div> 102</div> 103</div> 104</div> 105<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 106<td align="left"></td> 107<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 108 Distributed under the Boost Software License, Version 1.0. (See accompanying 109 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>) 110 </p> 111</div></td> 112</tr></table> 113<hr> 114<div class="spirit-nav"> 115<a accesskey="p" href="pinned_allocator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.async.future_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="wait_for_all.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 116</div> 117</body> 118</html> 119
