tutorial.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Tutorial</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="../index.html" title="Chapter&#160;1.&#160;Boost.Compute">
  9. <link rel="prev" href="design.html" title="Design">
  10. <link rel="next" href="advanced_topics.html" title="Advanced Topics">
  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="design.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><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="advanced_topics.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27. <a name="boost_compute.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial">Tutorial</a>
  28. </h2></div></div></div>
  29. <div class="toc"><dl class="toc">
  30. <dt><span class="section"><a href="tutorial.html#boost_compute.tutorial.hello_world">Hello World</a></span></dt>
  31. <dt><span class="section"><a href="tutorial.html#boost_compute.tutorial.transferring_data">Transferring
  32. Data</a></span></dt>
  33. <dt><span class="section"><a href="tutorial.html#boost_compute.tutorial.transforming_data">Transforming
  34. Data</a></span></dt>
  35. </dl></div>
  36. <div class="section">
  37. <div class="titlepage"><div><div><h3 class="title">
  38. <a name="boost_compute.tutorial.hello_world"></a><a class="link" href="tutorial.html#boost_compute.tutorial.hello_world" title="Hello World">Hello World</a>
  39. </h3></div></div></div>
  40. <p>
  41. The hello world example gives a simple application that prints the name of
  42. the default compute device on the system.
  43. </p>
  44. <p>
  45. The <code class="computeroutput">boost::compute::system</code>
  46. class provides access to the OpenCL platforms and devices present on the
  47. host system.
  48. </p>
  49. <p>
  50. Compute devices are represented with the <code class="computeroutput">device</code>
  51. class.
  52. </p>
  53. <p>
  54. </p>
  55. <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
  56. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">compute</span><span class="special">/</span><span class="identifier">core</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  57. <span class="keyword">namespace</span> <span class="identifier">compute</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">;</span>
  58. <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
  59. <span class="special">{</span>
  60. <span class="comment">// get the default device</span>
  61. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">device</span> <span class="identifier">device</span> <span class="special">=</span> <span class="identifier">compute</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">default_device</span><span class="special">();</span>
  62. <span class="comment">// print the device's name and platform</span>
  63. <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"hello from "</span> <span class="special">&lt;&lt;</span> <span class="identifier">device</span><span class="special">.</span><span class="identifier">name</span><span class="special">();</span>
  64. <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">" (platform: "</span> <span class="special">&lt;&lt;</span> <span class="identifier">device</span><span class="special">.</span><span class="identifier">platform</span><span class="special">().</span><span class="identifier">name</span><span class="special">()</span> <span class="special">&lt;&lt;</span> <span class="string">")"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
  65. <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
  66. <span class="special">}</span>
  67. </pre>
  68. <p>
  69. </p>
  70. </div>
  71. <div class="section">
  72. <div class="titlepage"><div><div><h3 class="title">
  73. <a name="boost_compute.tutorial.transferring_data"></a><a class="link" href="tutorial.html#boost_compute.tutorial.transferring_data" title="Transferring Data">Transferring
  74. Data</a>
  75. </h3></div></div></div>
  76. <p>
  77. Before any computation occurs, data must be transferred from the host to
  78. the compute device. The generic <code class="computeroutput"><a class="link" href="../boost/compute/copy.html" title="Function template copy">copy()</a></code>
  79. function provides a simple interface for transfering data and the generic
  80. <code class="computeroutput"><a class="link" href="../boost/compute/vector.html" title="Class template vector">vector&lt;T&gt;</a></code> class
  81. provides a container for storing data on a compute device.
  82. </p>
  83. <p>
  84. The following example shows how to transfer data from an array on the host
  85. to a <code class="computeroutput"><a class="link" href="../boost/compute/vector.html" title="Class template vector">vector&lt;T&gt;</a></code>
  86. on the device and then back to a separate <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code>
  87. on the host. At the end of the example both <code class="computeroutput"><span class="identifier">host_array</span></code>
  88. and <code class="computeroutput"><span class="identifier">host_vector</span></code> contain the
  89. same values which were copied through the memory on the compute device.
  90. </p>
  91. <p>
  92. </p>
  93. <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">vector</span><span class="special">&gt;</span>
  94. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">compute</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  95. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">compute</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  96. <span class="keyword">namespace</span> <span class="identifier">compute</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">;</span>
  97. <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
  98. <span class="special">{</span>
  99. <span class="comment">// get default device and setup context</span>
  100. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">device</span> <span class="identifier">device</span> <span class="special">=</span> <span class="identifier">compute</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">default_device</span><span class="special">();</span>
  101. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">context</span> <span class="identifier">context</span><span class="special">(</span><span class="identifier">device</span><span class="special">);</span>
  102. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">command_queue</span> <span class="identifier">queue</span><span class="special">(</span><span class="identifier">context</span><span class="special">,</span> <span class="identifier">device</span><span class="special">);</span>
  103. <span class="comment">// create data array on host</span>
  104. <span class="keyword">int</span> <span class="identifier">host_data</span><span class="special">[]</span> <span class="special">=</span> <span class="special">{</span> <span class="number">1</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">7</span><span class="special">,</span> <span class="number">9</span> <span class="special">};</span>
  105. <span class="comment">// create vector on device</span>
  106. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">device_vector</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="identifier">context</span><span class="special">);</span>
  107. <span class="comment">// copy from host to device</span>
  108. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span>
  109. <span class="identifier">host_data</span><span class="special">,</span> <span class="identifier">host_data</span> <span class="special">+</span> <span class="number">5</span><span class="special">,</span> <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">queue</span>
  110. <span class="special">);</span>
  111. <span class="comment">// create vector on host</span>
  112. <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">host_vector</span><span class="special">(</span><span class="number">5</span><span class="special">);</span>
  113. <span class="comment">// copy data back to host</span>
  114. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span>
  115. <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">queue</span>
  116. <span class="special">);</span>
  117. <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
  118. <span class="special">}</span>
  119. </pre>
  120. <p>
  121. </p>
  122. </div>
  123. <div class="section">
  124. <div class="titlepage"><div><div><h3 class="title">
  125. <a name="boost_compute.tutorial.transforming_data"></a><a class="link" href="tutorial.html#boost_compute.tutorial.transforming_data" title="Transforming Data">Transforming
  126. Data</a>
  127. </h3></div></div></div>
  128. <p>
  129. The following example shows how to calculate the square-root of a vector
  130. of <code class="computeroutput"><span class="keyword">float</span></code>s on a compute device
  131. using the <code class="computeroutput"><a class="link" href="../boost/compute/transform.html" title="Function transform">transform()</a></code>
  132. function.
  133. </p>
  134. <p>
  135. </p>
  136. <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">vector</span><span class="special">&gt;</span>
  137. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">algorithm</span><span class="special">&gt;</span>
  138. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">compute</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">transform</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  139. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">compute</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  140. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">compute</span><span class="special">/</span><span class="identifier">functional</span><span class="special">/</span><span class="identifier">math</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  141. <span class="keyword">namespace</span> <span class="identifier">compute</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">;</span>
  142. <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
  143. <span class="special">{</span>
  144. <span class="comment">// get default device and setup context</span>
  145. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">device</span> <span class="identifier">device</span> <span class="special">=</span> <span class="identifier">compute</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">default_device</span><span class="special">();</span>
  146. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">context</span> <span class="identifier">context</span><span class="special">(</span><span class="identifier">device</span><span class="special">);</span>
  147. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">command_queue</span> <span class="identifier">queue</span><span class="special">(</span><span class="identifier">context</span><span class="special">,</span> <span class="identifier">device</span><span class="special">);</span>
  148. <span class="comment">// generate random data on the host</span>
  149. <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">host_vector</span><span class="special">(</span><span class="number">10000</span><span class="special">);</span>
  150. <span class="identifier">std</span><span class="special">::</span><span class="identifier">generate</span><span class="special">(</span><span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">rand</span><span class="special">);</span>
  151. <span class="comment">// create a vector on the device</span>
  152. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">device_vector</span><span class="special">(</span><span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">size</span><span class="special">(),</span> <span class="identifier">context</span><span class="special">);</span>
  153. <span class="comment">// transfer data from the host to the device</span>
  154. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span>
  155. <span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">queue</span>
  156. <span class="special">);</span>
  157. <span class="comment">// calculate the square-root of each element in-place</span>
  158. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">transform</span><span class="special">(</span>
  159. <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span>
  160. <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span>
  161. <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span>
  162. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">sqrt</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;(),</span>
  163. <span class="identifier">queue</span>
  164. <span class="special">);</span>
  165. <span class="comment">// copy values back to the host</span>
  166. <span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span>
  167. <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">device_vector</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">host_vector</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">queue</span>
  168. <span class="special">);</span>
  169. <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
  170. <span class="special">}</span>
  171. </pre>
  172. <p>
  173. </p>
  174. </div>
  175. </div>
  176. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  177. <td align="left"></td>
  178. <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
  179. Distributed under the Boost Software License, Version 1.0. (See accompanying
  180. 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>)
  181. </p>
  182. </div></td>
  183. </tr></table>
  184. <hr>
  185. <div class="spirit-nav">
  186. <a accesskey="p" href="design.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><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="advanced_topics.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  187. </div>
  188. </body>
  189. </html>