1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function template reverse_string_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="Boost.Sort"> 8<link rel="up" href="../../../header/boost/sort/spreadsort/string_sort_hpp.html" title="Header <boost/sort/spreadsort/string_sort.hpp>"> 9<link rel="prev" href="reverse__idm45878543698320.html" title="Function template reverse_string_sort"> 10<link rel="next" href="reverse__idm45878543641456.html" title="Function template reverse_string_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="reverse__idm45878543698320.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/sort/spreadsort/string_sort_hpp.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="reverse__idm45878543641456.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.sort.spreadsort.reverse__idm45878543665984"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function template reverse_string_sort</span></h2> 29<p>boost::sort::spreadsort::reverse_string_sort — String sort algorithm using range, allowing character-type overloads. </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: <<a class="link" href="../../../header/boost/sort/spreadsort/string_sort_hpp.html" title="Header <boost/sort/spreadsort/string_sort.hpp>">boost/sort/spreadsort/string_sort.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Range<span class="special">,</span> <span class="keyword">typename</span> Compare<span class="special">,</span> <span class="keyword">typename</span> Unsigned_char_type<span class="special">></span> 36 <span class="keyword">void</span> <span class="identifier">reverse_string_sort</span><span class="special">(</span><span class="identifier">Range</span> <span class="special">&</span> range<span class="special">,</span> <span class="identifier">Compare</span> comp<span class="special">,</span> 37 <span class="identifier">Unsigned_char_type</span> unused<span class="special">)</span><span class="special">;</span></pre></div> 38<div class="refsect1"> 39<a name="idm45477844462800"></a><h2>Description</h2> 40<p>(All variants fall back to <code class="computeroutput">boost::sort::pdqsort</code> if the data size is too small, < detail::min_sort_size).</p> 41<p><code class="computeroutput">string_sort</code> is a fast templated in-place hybrid radix/comparison algorithm, which in testing tends to be roughly 50% to 2X faster than <code class="computeroutput">std::sort</code> for large tests (>=100kB).<br> 42Worst-case performance is <span class="emphasis"><em> O(N * (lg(range)/s + s)) </em></span>, so <code class="computeroutput">string_sort</code> is asymptotically faster than pure comparison-based algorithms. <br> 43<br> 44Some performance plots of runtime vs. n and log(range) are provided:<br> 45 <a href="../../../../../doc/graph/windows_integer_sort.htm" target="_top">windows_integer_sort</a> <br> 46 <a href="../../../../../doc/graph/osx_integer_sort.htm" target="_top">osx_integer_sort</a></p> 47<p> 48 49 50 51 52 53</p> 54<div class="warning"><table border="0" summary="Warning"> 55<tr> 56<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../doc/src/images/warning.png"></td> 57<th align="left">Warning</th> 58</tr> 59<tr><td align="left" valign="top"><p>Throwing an exception may cause data loss. This will also throw if a small vector resize throws, in which case there will be no data loss. </p></td></tr> 60</table></div> 61<p> 62</p> 63<div class="warning"><table border="0" summary="Warning"> 64<tr> 65<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../doc/src/images/warning.png"></td> 66<th align="left">Warning</th> 67</tr> 68<tr><td align="left" valign="top"><p>Invalid arguments cause undefined behaviour. </p></td></tr> 69</table></div> 70<p> 71</p> 72<div class="note"><table border="0" summary="Note"> 73<tr> 74<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td> 75<th align="left">Note</th> 76</tr> 77<tr><td align="left" valign="top"><p><code class="computeroutput">spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</p></td></tr> 78</table></div> 79<p> 80</p> 81<p>The lesser of <span class="emphasis"><em> O(N*log(N)) </em></span> comparisons and <span class="emphasis"><em> O(N*log(K/S + S)) </em></span>operations worst-case, where: </p> 82<p> 83 84</p> 85<p>* N is <code class="computeroutput">last</code> - <code class="computeroutput">first</code>, </p> 86<p> 87 88</p> 89<p>* K is the log of the range in bits (32 for 32-bit integers using their full range), </p> 90<p> 91 92</p> 93<p>* S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </p> 94<p> 95 96</p> 97<div class="variablelist"><table border="0" class="variablelist compact"> 98<colgroup> 99<col align="left" valign="top"> 100<col> 101</colgroup> 102<tbody> 103<tr> 104<td><p><span class="term">Parameters:</span></p></td> 105<td><div class="variablelist"><table border="0" class="variablelist compact"> 106<colgroup> 107<col align="left" valign="top"> 108<col> 109</colgroup> 110<tbody> 111<tr> 112<td><p><span class="term"><code class="computeroutput">comp</code></span></p></td> 113<td><p>A binary functor that returns whether the first element passed to it should go before the second in order. </p></td> 114</tr> 115<tr> 116<td><p><span class="term"><code class="computeroutput">range</code></span></p></td> 117<td><p>Range [first, last) for sorting. </p></td> 118</tr> 119<tr> 120<td><p><span class="term"><code class="computeroutput">unused</code></span></p></td> 121<td><p>value with the same type as the result of the [] operator, defining the Unsigned_char_type. The actual value is unused.</p></td> 122</tr> 123</tbody> 124</table></div></td> 125</tr> 126<tr> 127<td><p><span class="term">Template Parameters:</span></p></td> 128<td><div class="variablelist"><table border="0" class="variablelist compact"> 129<colgroup> 130<col align="left" valign="top"> 131<col> 132</colgroup> 133<tbody><tr> 134<td><p><span class="term"><code class="computeroutput">Unsigned_char_type</code></span></p></td> 135<td><p>Unsigned character type used for string.</p></td> 136</tr></tbody> 137</table></div></td> 138</tr> 139<tr> 140<td><p><span class="term">Requires:</span></p></td> 141<td><p>[<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) is a valid range. </p></td> 142</tr> 143<tr> 144<td><p><span class="term">Postconditions:</span></p></td> 145<td><p>The elements in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) are sorted in ascending order.</p></td> 146</tr> 147<tr> 148<td><p><span class="term">Returns:</span></p></td> 149<td><p><code class="computeroutput">void</code>.</p></td> 150</tr> 151<tr> 152<td><p><span class="term">Throws:</span></p></td> 153<td>std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves), the right shift, subtraction of right-shifted elements, functors, or any operations on iterators throw.</td> 154</tr> 155</tbody> 156</table></div> 157</div> 158</div> 159<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 160<td align="left"></td> 161<td align="right"><div class="copyright-footer">Copyright © 2014-2017 Steven 162 Ross, Francisco Tapia, Orson Peters<p> 163 Distributed under the <a href="http://boost.org/LICENSE_1_0.txt" target="_top">Boost 164 Software License, Version 1.0</a>. 165 </p> 166</div></td> 167</tr></table> 168<hr> 169<div class="spirit-nav"> 170<a accesskey="p" href="reverse__idm45878543698320.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/sort/spreadsort/string_sort_hpp.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="reverse__idm45878543641456.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 171</div> 172</body> 173</html> 174
