Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / stable_partition.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Function template stable_partition</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.stable_partition_hpp" title="Header &lt;boost/compute/algorithm/stable_partition.hpp&gt;">
9 <link rel="prev" href="sort_by_key.html" title="Function sort_by_key">
10 <link rel="next" href="stable_sort.html" title="Function stable_sort">
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="sort_by_key.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.stable_partition_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="stable_sort.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.compute.stable_partition"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Function template stable_partition</span></h2>
29 <p>boost::compute::stable_partition &#8212; Partitioning algorithm. </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.stable_partition_hpp" title="Header &lt;boost/compute/algorithm/stable_partition.hpp&gt;">boost/compute/algorithm/stable_partition.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> UnaryPredicate<span class="special">&gt;</span> 
36   <span class="identifier">Iterator</span> <span class="identifier">stable_partition</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> 
37                             <span class="identifier">UnaryPredicate</span> predicate<span class="special">,</span> 
38                             <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>
39 <div class="refsect1">
40 <a name="idm46113330432016"></a><h2>Description</h2>
41 <p>Partitions the elements in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) according to <code class="computeroutput">predicate</code>. The order of the elements is preserved. 
42
43 Space complexity: \Omega(3n)</p>
44 <p><span class="bold"><strong>See Also:</strong></span></p>
45 <p>is_partitioned() and partition() </p>
46 <p>
47 </p>
48 <p>
49 </p>
50 <div class="variablelist"><table border="0" class="variablelist compact">
51 <colgroup>
52 <col align="left" valign="top">
53 <col>
54 </colgroup>
55 <tbody>
56 <tr>
57 <td><p><span class="term">Parameters:</span></p></td>
58 <td><div class="variablelist"><table border="0" class="variablelist compact">
59 <colgroup>
60 <col align="left" valign="top">
61 <col>
62 </colgroup>
63 <tbody>
64 <tr>
65 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
66 <td><p>Iterator pointing to start of range </p></td>
67 </tr>
68 <tr>
69 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
70 <td><p>Iterator pointing to end of range </p></td>
71 </tr>
72 <tr>
73 <td><p><span class="term"><code class="computeroutput">predicate</code></span></p></td>
74 <td><p>Unary predicate to be applied on each element </p></td>
75 </tr>
76 <tr>
77 <td><p><span class="term"><code class="computeroutput">queue</code></span></p></td>
78 <td><p>Queue on which to execute</p></td>
79 </tr>
80 </tbody>
81 </table></div></td>
82 </tr>
83 <tr>
84 <td><p><span class="term">Returns:</span></p></td>
85 <td><p>Iterator pointing to end of true values</p></td>
86 </tr>
87 </tbody>
88 </table></div>
89 </div>
90 </div>
91 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
92 <td align="left"></td>
93 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
94         Distributed under the Boost Software License, Version 1.0. (See accompanying
95         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>)
96       </p>
97 </div></td>
98 </tr></table>
99 <hr>
100 <div class="spirit-nav">
101 <a accesskey="p" href="sort_by_key.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.stable_partition_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="stable_sort.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
102 </div>
103 </body>
104 </html>