1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>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 1. Range 2.0"> 8<link rel="up" href="../mutating.html" title="Mutating algorithms"> 9<link rel="prev" href="partial_sort.html" title="partial_sort"> 10<link rel="next" href="random_shuffle.html" title="random_shuffle"> 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="partial_sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="random_shuffle.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="range.reference.algorithms.mutating.partition"></a><a class="link" href="partition.html" title="partition">partition</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.mutating.partition.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.mutating.partition.prototype"></a></span><a class="link" href="partition.html#range.reference.algorithms.mutating.partition.prototype">Prototype</a> 32 </h6> 33<p> 34</p> 35<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 37 <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> 38 <span class="special">></span> 39<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> 40<span class="identifier">partition</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 41 42<span class="keyword">template</span><span class="special"><</span> 43 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 44 <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> 45 <span class="special">></span> 46<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> 47<span class="identifier">partition</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 48 49<span class="keyword">template</span><span class="special"><</span> 50 <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> 51 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 52 <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> 53 <span class="special">></span> 54<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> 55<span class="identifier">partition</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 56 57<span class="keyword">template</span><span class="special"><</span> 58 <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> 59 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 60 <span class="keyword">class</span> <span class="identifier">UnaryPredicate</span> 61 <span class="special">></span> 62<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> 63<span class="identifier">partition</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">UnaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 64</pre> 65<p> 66 </p> 67<h6> 68<a name="range.reference.algorithms.mutating.partition.h1"></a> 69 <span class="phrase"><a name="range.reference.algorithms.mutating.partition.description"></a></span><a class="link" href="partition.html#range.reference.algorithms.mutating.partition.description">Description</a> 70 </h6> 71<p> 72 <code class="computeroutput"><span class="identifier">partition</span></code> orders the 73 elements in <code class="computeroutput"><span class="identifier">rng</span></code> based 74 on <code class="computeroutput"><span class="identifier">pred</span></code>, such that the 75 elements that satisfy <code class="computeroutput"><span class="identifier">pred</span></code> 76 precede the elements that do not. In the versions that return a single 77 iterator, the return value is the middle iterator. In the versions that 78 have a configurable range_return, <code class="computeroutput"><span class="identifier">found</span></code> 79 corresponds to the middle iterator. 80 </p> 81<h6> 82<a name="range.reference.algorithms.mutating.partition.h2"></a> 83 <span class="phrase"><a name="range.reference.algorithms.mutating.partition.definition"></a></span><a class="link" href="partition.html#range.reference.algorithms.mutating.partition.definition">Definition</a> 84 </h6> 85<p> 86 Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">partition</span><span class="special">.</span><span class="identifier">hpp</span></code> 87 </p> 88<h6> 89<a name="range.reference.algorithms.mutating.partition.h3"></a> 90 <span class="phrase"><a name="range.reference.algorithms.mutating.partition.requirements"></a></span><a class="link" href="partition.html#range.reference.algorithms.mutating.partition.requirements">Requirements</a> 91 </h6> 92<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 93<li class="listitem"> 94 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a 95 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward 96 Range</a> Concept. For C++ versions prior to C++11 the underlying 97 std::partition requires Bidirectional Iterators, hence the requirement 98 for older library versions is for a <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional 99 Range</a>. 100 </li> 101<li class="listitem"> 102 <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code> is 103 a model of the <code class="computeroutput"><span class="identifier">PredicateConcept</span></code>. 104 </li> 105<li class="listitem"> 106 <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value 107 type is convertible to <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>'s 108 argument type. 109 </li> 110</ul></div> 111<h6> 112<a name="range.reference.algorithms.mutating.partition.h4"></a> 113 <span class="phrase"><a name="range.reference.algorithms.mutating.partition.complexity"></a></span><a class="link" href="partition.html#range.reference.algorithms.mutating.partition.complexity">Complexity</a> 114 </h6> 115<p> 116 Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> applications of <code class="computeroutput"><span class="identifier">pred</span></code>, 117 and at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">/</span> <span class="number">2</span></code> 118 swaps. 119 </p> 120</div> 121<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 122<td align="left"></td> 123<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 124 Neil Groves<p> 125 Distributed under the Boost Software License, Version 1.0. (See accompanying 126 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>) 127 </p> 128</div></td> 129</tr></table> 130<hr> 131<div class="spirit-nav"> 132<a accesskey="p" href="partial_sort.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="random_shuffle.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 133</div> 134</body> 135</html> 136
