2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
2006-10-18 06:08:05 +00:00
<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
2004-11-28 03:35:12 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
< meta name = "generator" content = "Docutils 0.3.6: http://docutils.sourceforge.net/" />
< title > The MPL Reference Manual: sort</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
< 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 > < a href = "./reverse.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./stable-partition.html" class = "navigation-link" > Back</ a > < a href = "./reverse.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./transformation-algorithms.html" class = "navigation-link" > Up</ a > < a href = "../refmanual.html" class = "navigation-link" > Home</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC</ a ></ span ></ td >
< 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 >
</ tr ></ table >< div class = "header-separator" ></ div >
< div class = "section" id = "sort" >
< h1 >< a class = "toc-backref" href = "./transformation-algorithms.html#id424" name = "sort" > sort</ a ></ h1 >
< div class = "section" id = "sort-synopsis" >
< h3 >< a class = "subsection-title" href = "#synopsis" name = "synopsis" > Synopsis</ a ></ h3 >
< pre class = "literal-block" >
template<
typename Seq
, typename Pred = < a href = "./less.html" class = "identifier" > less</ a > < _1,_2>
, typename In = < em > unspecified</ em >
>
struct < a href = "./sort.html" class = "identifier" > sort</ a >
{
typedef < em > unspecified</ em > type;
};
</ pre >
</ div >
< div class = "section" id = "sort-description" >
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
< 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 > < Seq> ::type</ span ></ tt > , < tt class = "literal" >< span class = "pre" >< a href = "./end.html" class = "identifier" > end</ a > < Seq> ::type</ span ></ tt > ) sorted according
to the ordering relation < tt class = "literal" >< span class = "pre" > Pred</ span ></ tt > .</ p >
< p > [< em > Note:</ em > This wording applies to a no-inserter version(s) of the algorithm. See the
< cite > Expression semantics</ cite > subsection for a precise specification of the algorithm's
details in all cases — < em > end note</ em > ]</ p >
</ div >
< div class = "section" id = "sort-header" >
< h3 >< a class = "subsection-title" href = "#header" name = "header" > Header</ a ></ h3 >
< pre class = "literal-block" >
#include < < a href = "../../../../boost/mpl/sort.hpp" class = "header" > boost/mpl/sort.hpp</ a > >
</ pre >
</ div >
< div class = "section" id = "sort-model-of" >
< h3 >< a class = "subsection-title" href = "#model-of" name = "model-of" > Model of</ a ></ h3 >
< p >< a class = "reference" href = "./reversible-algorithm.html" > Reversible Algorithm</ a ></ p >
</ div >
< div class = "section" id = "sort-parameters" >
< h3 >< a class = "subsection-title" href = "#parameters" name = "parameters" > Parameters</ a ></ h3 >
< table border = "1" class = "table" >
< colgroup >
< col width = "22%" />
< col width = "41%" />
< col width = "36%" />
</ colgroup >
< thead valign = "bottom" >
< tr >< th > Parameter</ th >
< th > Requirement</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td >< tt class = "literal" >< span class = "pre" > Seq</ span ></ tt ></ td >
< td >< a class = "reference" href = "./forward-sequence.html" > Forward Sequence</ a ></ td >
< td > An original sequence.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > Pred</ span ></ tt ></ td >
< td > Binary < a class = "reference" href = "./lambda-expression.html" > Lambda Expression</ a ></ td >
< td > An ordering relation.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > In</ span ></ tt ></ td >
< td >< a class = "reference" href = "./inserter.html" > Inserter</ a ></ td >
< td > An inserter.</ td >
</ tr >
</ tbody >
</ table >
</ div >
< div class = "section" id = "sort-expression-semantics" >
< h3 >< a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics</ a ></ h3 >
< p > The semantics of an expression are defined only
where they differ from, or are not defined in < a class = "reference" href = "./reversible-algorithm.html" > Reversible Algorithm</ a > .</ p >
< p > For any < a class = "reference" href = "./forward-sequence.html" > Forward Sequence</ a > < tt class = "literal" >< span class = "pre" > s</ span ></ tt > , a binary < a class = "reference" href = "./lambda-expression.html" > Lambda Expression</ a > < tt class = "literal" >< span class = "pre" > pred</ span ></ tt > , and an
< a class = "reference" href = "./inserter.html" > Inserter</ a > < tt class = "literal" >< span class = "pre" > in</ span ></ tt > :</ p >
< pre class = "literal-block" >
typedef < a href = "./sort.html" class = "identifier" > sort</ a > < s,pred,in> ::type r;
</ pre >
< table class = "field-list" frame = "void" rules = "none" >
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
< tr class = "field" >< th class = "field-name" > Return type:</ th >< td class = "field-body" > A type.</ td >
</ tr >
< 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 > < s> ::value</ span > < span class = "pre" > < =</ span > < span class = "pre" > 1</ span ></ tt > , equivalent to</ p >
< pre class = "literal-block" >
typedef < a href = "./copy.html" class = "identifier" > copy</ a > < s,in> ::type r;
</ pre >
< p > otherwise equivalent to</ p >
< pre class = "last literal-block" >
typedef < a href = "./back-inserter.html" class = "identifier" > back_inserter</ a > < < a href = "./vector.html" class = "identifier" > vector</ a > <> > aux_in;
typedef < a href = "./lambda.html" class = "identifier" > lambda</ a > < pred> ::type p;
typedef < a href = "./begin.html" class = "identifier" > begin</ a > < s> ::type pivot;
typedef < a href = "./partition.html" class = "identifier" > partition</ a > <
< a href = "./iterator-range.html" class = "identifier" > iterator_range</ a > < < a href = "./next.html" class = "identifier" > next</ a > < pivot> ::type, < a href = "./end.html" class = "identifier" > end</ a > < s> ::type >
, apply_wrap2< p,_1,< a href = "./deref.html" class = "identifier" > deref</ a > < pivot> ::type>
, aux_in
, aux_in
> ::type partitioned;
typedef < a href = "./sort.html" class = "identifier" > sort</ a > < partitioned::first,p,aux_in > ::type part1;
typedef < a href = "./sort.html" class = "identifier" > sort</ a > < partitioned::second,p,aux_in > ::type part2;
typedef < a href = "./copy.html" class = "identifier" > copy</ a > <
< a href = "./joint-view.html" class = "identifier" > joint_view</ a > <
< a href = "./joint-view.html" class = "identifier" > joint_view</ a > < part1,< a href = "./single-view.html" class = "identifier" > single_view</ a > < < a href = "./deref.html" class = "identifier" > deref</ a > < pivot> ::type > >
, part2
>
, in
> ::type r;
</ pre >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
< div class = "section" id = "sort-complexity" >
< h3 >< a class = "subsection-title" href = "#complexity" name = "complexity" > Complexity</ a ></ h3 >
< 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 > < s> ::value</ span ></ tt > , quadratic at worst.</ p >
</ div >
< div class = "section" id = "sort-example" >
< h3 >< a class = "subsection-title" href = "#example" name = "example" > Example</ a ></ h3 >
< pre class = "literal-block" >
typedef < a href = "./vector-c.html" class = "identifier" > vector_c</ a > < int,3,4,0,-5,8,-1,7> numbers;
typedef < a href = "./vector-c.html" class = "identifier" > vector_c</ a > < int,-5,-1,0,3,4,7,8> expected;
typedef < a href = "./sort.html" class = "identifier" > sort</ a > < numbers> ::type result;
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( < a href = "./equal.html" class = "identifier" > equal</ a > < result, expected, < a href = "./equal-to.html" class = "identifier" > equal_to</ a > < _,_> > ));
</ pre >
</ div >
< div class = "section" id = "sort-see-also" >
< h3 >< a class = "subsection-title" href = "#see-also" name = "see-also" > See also</ a ></ h3 >
< p >< a class = "reference" href = "./transformation-algorithms.html" > Transformation Algorithms</ a > , < a class = "reference" href = "./reversible-algorithm.html" > Reversible Algorithm</ a > , < a class = "refentry reference" href = "./partition.html" >< tt class = "refentry literal" >< span class = "pre" > partition</ span ></ tt ></ a ></ p >
<!-- modtime: November 10, 2004 22:01:33 +0000 -->
<!-- Algorithms/Transformation Algorithms//reverse |100 -->
</ div >
</ div >
< div class = "footer-separator" ></ div >
< 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 > < a href = "./reverse.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./stable-partition.html" class = "navigation-link" > Back</ a > < a href = "./reverse.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./transformation-algorithms.html" class = "navigation-link" > Up</ a > < a href = "../refmanual.html" class = "navigation-link" > Home</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC</ a ></ span ></ td >
</ tr ></ table ></ body >
</ html >
