libs/compute/doc/html/boost/compute/sort.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function sort</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.algorithm.sort_hpp" title="Header &lt;boost/compute/algorithm/sort.hpp&gt;">
   9 <link rel="prev" href="set_union.html" title="Function template set_union">
  10 <link rel="next" href="sort_by_key.html" title="Function sort_by_key">
  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="set_union.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.sort_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="sort_by_key.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.sort"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function sort</span></h2>
  29 <p>boost::compute::sort</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.algorithm.sort_hpp" title="Header &lt;boost/compute/algorithm/sort.hpp&gt;">boost/compute/algorithm/sort.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterator<span class="special">,</span> <span class="keyword">typename</span> Compare<span class="special">&gt;</span>
  36   <span class="keyword">void</span> <span class="identifier">sort</span><span class="special">(</span><span class="identifier">Iterator</span> first<span class="special">,</span> <span class="identifier">Iterator</span> last<span class="special">,</span> <span class="identifier">Compare</span> compare<span class="special">,</span>
  37             <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  38 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterator<span class="special">&gt;</span>
  39   <span class="keyword">void</span> <span class="identifier">sort</span><span class="special">(</span><span class="identifier">Iterator</span> first<span class="special">,</span> <span class="identifier">Iterator</span> last<span class="special">,</span>
  40             <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  41 <div class="refsect1">
  42 <a name="idm46113330644064"></a><h2>Description</h2>
  43 <p>Sorts the values in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) according to <code class="computeroutput">compare</code>.</p>
  44 <p>
  45 For example, to sort a vector on the device: </p>
  46 <pre class="programlisting"><span class="comment">// create vector on the device with data</span>
  47 <span class="keyword">float</span> <span class="identifier">data</span><span class="special">[</span><span class="special">]</span> <span class="special">=</span> <span class="special">{</span> <span class="number">2</span><span class="special">.</span><span class="identifier">f</span><span class="special">,</span> <span class="number">4</span><span class="special">.</span><span class="identifier">f</span><span class="special">,</span> <span class="number">1</span><span class="special">.</span><span class="identifier">f</span><span class="special">,</span> <span class="number">3</span><span class="special">.</span><span class="identifier">f</span> <span class="special">}</span><span class="special">;</span>
  48 <span class="identifier">boost</span><span class="special">::</span><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">vec</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">data</span> <span class="special">+</span> <span class="number">4</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
  49
  50 <span class="comment">// sort the vector on the device</span>
  51 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
  52 </pre>
  53 <p>The sort() algorithm can also be directly used with host iterators. This example will automatically transfer the data to the device, sort it, and then transfer the data back to the host: </p>
  54 <pre class="programlisting"><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">data</span> <span class="special">=</span> <span class="special">{</span> <span class="number">9</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">4</span><span class="special">,</span> <span class="number">6</span><span class="special">,</span> <span class="number">7</span> <span class="special">}</span><span class="special">;</span>
  55
  56 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">sort</span><span class="special">(</span><span class="identifier">data</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">data</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
  57 </pre>
  58 <p>Space complexity: \Omega(n)</p>
  59 <p><span class="bold"><strong>See Also:</strong></span></p>
  60 <p>is_sorted() </p>
  61 <p>
  62 </p>
  63 <p>
  64 </p>
  65 <div class="variablelist"><table border="0" class="variablelist compact">
  66 <colgroup>
  67 <col align="left" valign="top">
  68 <col>
  69 </colgroup>
  70 <tbody><tr>
  71 <td><p><span class="term">Parameters:</span></p></td>
  72 <td><div class="variablelist"><table border="0" class="variablelist compact">
  73 <colgroup>
  74 <col align="left" valign="top">
  75 <col>
  76 </colgroup>
  77 <tbody>
  78 <tr>
  79 <td><p><span class="term"><code class="computeroutput">compare</code></span></p></td>
  80 <td><p>comparison function (by default <code class="computeroutput">less</code>) </p></td>
  81 </tr>
  82 <tr>
  83 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
  84 <td><p>first element in the range to sort </p></td>
  85 </tr>
  86 <tr>
  87 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
  88 <td><p>last element in the range to sort </p></td>
  89 </tr>
  90 <tr>
  91 <td><p><span class="term"><code class="computeroutput">queue</code></span></p></td>
  92 <td><p>command queue to perform the operation</p></td>
  93 </tr>
  94 </tbody>
  95 </table></div></td>
  96 </tr></tbody>
  97 </table></div>
  98 </div>
  99 </div>
 100 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 101 <td align="left"></td>
 102 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 103         Distributed under the Boost Software License, Version 1.0. (See accompanying
 104         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>)
 105       </p>
 106 </div></td>
 107 </tr></table>
 108 <hr>
 109 <div class="spirit-nav">
 110 <a accesskey="p" href="set_union.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.sort_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="sort_by_key.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 111 </div>
 112 </body>
 113 </html>