• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
7<title>The MPL Reference Manual: sort</title>
8<link rel="stylesheet" href="../style.css" type="text/css" />
9</head>
10<body class="docframe refmanual">
11<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./stable-partition.html" class="navigation-link">Prev</a>&nbsp;<a href="./reverse.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./stable-partition.html" class="navigation-link">Back</a>&nbsp;<a href="./reverse.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./transformation-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
12<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./transformation-algorithms.html" class="navigation-link">Transformation Algorithms</a> / <a href="./sort.html" class="navigation-link">sort</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="sort">
15<h1><a class="toc-backref" href="./transformation-algorithms.html#id1496">sort</a></h1>
16<div class="section" id="id705">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt;
20      typename Seq
21    , typename Pred = <a href="./less.html" class="identifier">less</a>&lt;<a href="./placeholders.html" class="identifier">_1</a>,<a href="./placeholders.html" class="identifier">_2</a>&gt;
22    , typename In = <em>unspecified</em>
23    &gt;
24struct <a href="./sort.html" class="identifier">sort</a>
25{
26    typedef <em>unspecified</em> type;
27};
28</pre>
29</div>
30<div class="section" id="id706">
31<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
32<p>Returns a new sequence of all elements in the range [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;Seq&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;Seq&gt;::type</span></tt>) sorted according
33to the ordering relation <tt class="literal"><span class="pre">Pred</span></tt>.</p>
34<p>[<em>Note:</em> This wording applies to a no-inserter version(s) of the algorithm. See the
35<cite>Expression semantics</cite> subsection for a precise specification of the algorithm's
36details in all cases — <em>end note</em>]</p>
37</div>
38<div class="section" id="id707">
39<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
40<pre class="literal-block">
41#include &lt;<a href="../../../../boost/mpl/sort.hpp" class="header">boost/mpl/sort.hpp</a>&gt;
42</pre>
43</div>
44<div class="section" id="id708">
45<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
46<p><a class="reference internal" href="./reversible-algorithm.html">Reversible Algorithm</a></p>
47</div>
48<div class="section" id="id709">
49<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
50<table border="1" class="docutils table">
51<colgroup>
52<col width="22%" />
53<col width="41%" />
54<col width="36%" />
55</colgroup>
56<thead valign="bottom">
57<tr><th class="head">Parameter</th>
58<th class="head">Requirement</th>
59<th class="head">Description</th>
60</tr>
61</thead>
62<tbody valign="top">
63<tr><td><tt class="literal"><span class="pre">Seq</span></tt></td>
64<td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
65<td>An original sequence.</td>
66</tr>
67<tr><td><tt class="literal"><span class="pre">Pred</span></tt></td>
68<td>Binary <a class="reference internal" href="./lambda-expression.html">Lambda Expression</a></td>
69<td>An ordering relation.</td>
70</tr>
71<tr><td><tt class="literal"><span class="pre">In</span></tt></td>
72<td><a class="reference internal" href="./inserter.html">Inserter</a></td>
73<td>An inserter.</td>
74</tr>
75</tbody>
76</table>
77</div>
78<div class="section" id="id710">
79<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
80<p>The semantics of an expression are defined only
81where they differ from, or are not defined in <a class="reference internal" href="./reversible-algorithm.html">Reversible Algorithm</a>.</p>
82<p>For any <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, a binary <a class="reference internal" href="./lambda-expression.html">Lambda Expression</a> <tt class="literal"><span class="pre">pred</span></tt>, and an
83<a class="reference internal" href="./inserter.html">Inserter</a> <tt class="literal"><span class="pre">in</span></tt>:</p>
84<pre class="literal-block">
85typedef <a href="./sort.html" class="identifier">sort</a>&lt;s,pred,in&gt;::type r;
86</pre>
87<table class="docutils field-list" frame="void" rules="none">
88<col class="field-name" />
89<col class="field-body" />
90<tbody valign="top">
91<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">A type.</p>
92</td>
93</tr>
94<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">If <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">&lt;=</span> <span class="pre">1</span></tt>, equivalent to</p>
95<pre class="literal-block">
96typedef <a href="./copy.html" class="identifier">copy</a>&lt;s,in&gt;::type r;
97</pre>
98<p>otherwise equivalent to</p>
99<pre class="last literal-block">
100typedef <a href="./back-inserter.html" class="identifier">back_inserter</a>&lt; <a href="./vector.html" class="identifier">vector</a>&lt;&gt; &gt; aux_in;
101typedef <a href="./lambda.html" class="identifier">lambda</a>&lt;pred&gt;::type p;
102
103typedef <a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type pivot;
104typedef <a href="./partition.html" class="identifier">partition</a>&lt;
105      <a href="./iterator-range.html" class="identifier">iterator_range</a>&lt; <a href="./next.html" class="identifier">next</a>&lt;pivot&gt;::type, <a href="./end.html" class="identifier">end</a>&lt;s&gt;::type &gt;
106    , apply_wrap2&lt;p,<a href="./placeholders.html" class="identifier">_1</a>,<a href="./deref.html" class="identifier">deref</a>&lt;pivot&gt;::type&gt;
107    , aux_in
108    , aux_in
109    &gt;::type partitioned;
110
111typedef <a href="./sort.html" class="identifier">sort</a>&lt;partitioned::first,p,aux_in &gt;::type part1;
112typedef <a href="./sort.html" class="identifier">sort</a>&lt;partitioned::second,p,aux_in &gt;::type part2;
113
114typedef <a href="./copy.html" class="identifier">copy</a>&lt;
115      <a href="./joint-view.html" class="identifier">joint_view</a>&lt;
116          <a href="./joint-view.html" class="identifier">joint_view</a>&lt;part1,<a href="./single-view.html" class="identifier">single_view</a>&lt; <a href="./deref.html" class="identifier">deref</a>&lt;pivot&gt;::type &gt; &gt;
117        , part2
118        &gt;
119    , in
120    &gt;::type r;
121</pre>
122</td>
123</tr>
124</tbody>
125</table>
126</div>
127<div class="section" id="id711">
128<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
129<p>Average <em>O(n log(n))</em> where <em>n</em> == <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span></tt>, quadratic at worst.</p>
130</div>
131<div class="section" id="id712">
132<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
133<pre class="literal-block">
134typedef <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,3,4,0,-5,8,-1,7&gt; numbers;
135typedef <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,-5,-1,0,3,4,7,8&gt; expected;
136typedef <a href="./sort.html" class="identifier">sort</a>&lt;numbers&gt;::type result;
137
138<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>&lt; result, expected, <a href="./equal-to.html" class="identifier">equal_to</a>&lt;_,_&gt; > ));
139</pre>
140</div>
141<div class="section" id="id713">
142<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
143<p><a class="reference internal" href="./transformation-algorithms.html">Transformation Algorithms</a>, <a class="reference internal" href="./reversible-algorithm.html">Reversible Algorithm</a>, <a class="reference internal" href="./partition.html">partition</a></p>
144<!-- Algorithms/Transformation Algorithms//reverse |100 -->
145</div>
146</div>
147
148<div class="footer-separator"></div>
149<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./stable-partition.html" class="navigation-link">Prev</a>&nbsp;<a href="./reverse.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./stable-partition.html" class="navigation-link">Back</a>&nbsp;<a href="./reverse.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./transformation-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
150<td><div class="copyright-footer"><div class="copyright">Copyright ©  2001-2009 Aleksey Gurtovoy and David Abrahams</div>
151Distributed under the Boost Software License, Version 1.0. (See accompanying
152file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body>
153</html>
154