1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns=
"http://www.w3.org/1999/xhtml">
4 <meta http-equiv=
"Content-Type" content=
"text/xhtml;charset=UTF-8"/>
5 <meta http-equiv=
"X-UA-Compatible" content=
"IE=9"/>
6 <meta name=
"generator" content=
"Doxygen 1.8.9.1"/>
7 <title>Boost.Sort: I:/modular-boost/libs/sort/include/boost/sort/spreadsort/string_sort.hpp Source File
</title>
8 <link href=
"tabs.css" rel=
"stylesheet" type=
"text/css"/>
9 <script type=
"text/javascript" src=
"jquery.js"></script>
10 <script type=
"text/javascript" src=
"dynsections.js"></script>
11 <link href=
"search/search.css" rel=
"stylesheet" type=
"text/css"/>
12 <script type=
"text/javascript" src=
"search/searchdata.js"></script>
13 <script type=
"text/javascript" src=
"search/search.js"></script>
14 <script type=
"text/javascript">
15 $(document).ready(function() { init_search(); });
17 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css" />
20 <div id=
"top"><!-- do not remove this div, it is closed by doxygen! -->
22 <table cellspacing=
"0" cellpadding=
"0">
24 <tr style=
"height: 56px;">
25 <td style=
"padding-left: 0.5em;">
26 <div id=
"projectname">Boost.Sort
33 <!-- end header part -->
34 <!-- Generated by Doxygen 1.8.9.1 -->
35 <script type=
"text/javascript">
36 var searchBox = new SearchBox(
"searchBox",
"search",false,'Search');
38 <div id=
"navrow1" class=
"tabs">
40 <li><a href=
"index.html"><span>Main
 Page
</span></a></li>
41 <li><a href=
"namespaces.html"><span>Namespaces
</span></a></li>
42 <li><a href=
"annotated.html"><span>Classes
</span></a></li>
43 <li class=
"current"><a href=
"files.html"><span>Files
</span></a></li>
45 <div id=
"MSearchBox" class=
"MSearchBoxInactive">
47 <img id=
"MSearchSelect" src=
"search/mag_sel.png"
48 onmouseover=
"return searchBox.OnSearchSelectShow()"
49 onmouseout=
"return searchBox.OnSearchSelectHide()"
51 <input type=
"text" id=
"MSearchField" value=
"Search" accesskey=
"S"
52 onfocus=
"searchBox.OnSearchFieldFocus(true)"
53 onblur=
"searchBox.OnSearchFieldFocus(false)"
54 onkeyup=
"searchBox.OnSearchFieldChange(event)"/>
55 </span><span class=
"right">
56 <a id=
"MSearchClose" href=
"javascript:searchBox.CloseResultsWindow()"><img id=
"MSearchCloseImg" border=
"0" src=
"search/close.png" alt=
""/></a>
62 <div id=
"navrow2" class=
"tabs2">
64 <li><a href=
"files.html"><span>File
 List
</span></a></li>
65 <li><a href=
"globals.html"><span>File
 Members
</span></a></li>
68 <!-- window showing the filter options -->
69 <div id=
"MSearchSelectWindow"
70 onmouseover=
"return searchBox.OnSearchSelectShow()"
71 onmouseout=
"return searchBox.OnSearchSelectHide()"
72 onkeydown=
"return searchBox.OnSearchSelectKey(event)">
75 <!-- iframe showing the search results (closed by default) -->
76 <div id=
"MSearchResultsWindow">
77 <iframe src=
"javascript:void(0)" frameborder=
"0"
78 name=
"MSearchResults" id=
"MSearchResults">
82 <div id=
"nav-path" class=
"navpath">
84 <li class=
"navelem"><a class=
"el" href=
"dir_d44c64559bbebec7f509842c48db8b23.html">include
</a></li><li class=
"navelem"><a class=
"el" href=
"dir_1878a3f4746a95c6aad317458cc7ef80.html">boost
</a></li><li class=
"navelem"><a class=
"el" href=
"dir_0dcad0da4f36218cbabb216021de9867.html">sort
</a></li><li class=
"navelem"><a class=
"el" href=
"dir_4aa236a92b75d6f514e733718a475329.html">spreadsort
</a></li> </ul>
88 <div class=
"headertitle">
89 <div class=
"title">string_sort.hpp
</div> </div>
91 <div class=
"contents">
92 <a href=
"string__sort_8hpp.html">Go to the documentation of this file.
</a><div class=
"fragment"><div class=
"line"><a name=
"l00001"></a><span class=
"lineno"> 1</span> <span class=
"comment">//Templated hybrid string_sort
</span></div>
93 <div class=
"line"><a name=
"l00002"></a><span class=
"lineno"> 2</span> </div>
94 <div class=
"line"><a name=
"l00003"></a><span class=
"lineno"> 3</span> <span class=
"comment">// Copyright Steven J. Ross
2001 -
2009.
</span></div>
95 <div class=
"line"><a name=
"l00004"></a><span class=
"lineno"> 4</span> <span class=
"comment">// Distributed under the Boost Software License, Version
1.0.
</span></div>
96 <div class=
"line"><a name=
"l00005"></a><span class=
"lineno"> 5</span> <span class=
"comment">// (See accompanying file LICENSE_1_0.txt or copy at
</span></div>
97 <div class=
"line"><a name=
"l00006"></a><span class=
"lineno"> 6</span> <span class=
"comment">// http://www.boost.org/LICENSE_1_0.txt)
</span></div>
98 <div class=
"line"><a name=
"l00007"></a><span class=
"lineno"> 7</span> </div>
99 <div class=
"line"><a name=
"l00008"></a><span class=
"lineno"> 8</span> <span class=
"comment">// See http://www.boost.org/libs/sort/ for library home page.
</span></div>
100 <div class=
"line"><a name=
"l00009"></a><span class=
"lineno"> 9</span> </div>
101 <div class=
"line"><a name=
"l00010"></a><span class=
"lineno"> 10</span> <span class=
"comment">/*
</span></div>
102 <div class=
"line"><a name=
"l00011"></a><span class=
"lineno"> 11</span> <span class=
"comment">Some improvements suggested by:
</span></div>
103 <div class=
"line"><a name=
"l00012"></a><span class=
"lineno"> 12</span> <span class=
"comment">Phil Endecott and Frank Gennari
</span></div>
104 <div class=
"line"><a name=
"l00013"></a><span class=
"lineno"> 13</span> <span class=
"comment">*/
</span></div>
105 <div class=
"line"><a name=
"l00014"></a><span class=
"lineno"> 14</span> </div>
106 <div class=
"line"><a name=
"l00015"></a><span class=
"lineno"> 15</span> <span class=
"preprocessor">#ifndef BOOST_STRING_SORT_HPP
</span></div>
107 <div class=
"line"><a name=
"l00016"></a><span class=
"lineno"> 16</span> <span class=
"preprocessor">#define BOOST_STRING_SORT_HPP
</span></div>
108 <div class=
"line"><a name=
"l00017"></a><span class=
"lineno"> 17</span> <span class=
"preprocessor">#include
<algorithm
></span></div>
109 <div class=
"line"><a name=
"l00018"></a><span class=
"lineno"> 18</span> <span class=
"preprocessor">#include
<vector
></span></div>
110 <div class=
"line"><a name=
"l00019"></a><span class=
"lineno"> 19</span> <span class=
"preprocessor">#include
<cstring
></span></div>
111 <div class=
"line"><a name=
"l00020"></a><span class=
"lineno"> 20</span> <span class=
"preprocessor">#include
<limits
></span></div>
112 <div class=
"line"><a name=
"l00021"></a><span class=
"lineno"> 21</span> <span class=
"preprocessor">#include
<boost/static_assert.hpp
></span></div>
113 <div class=
"line"><a name=
"l00022"></a><span class=
"lineno"> 22</span> <span class=
"preprocessor">#include
<boost/sort/spreadsort/detail/constants.hpp
></span></div>
114 <div class=
"line"><a name=
"l00023"></a><span class=
"lineno"> 23</span> <span class=
"preprocessor">#include
<boost/sort/spreadsort/detail/string_sort.hpp
></span></div>
115 <div class=
"line"><a name=
"l00024"></a><span class=
"lineno"> 24</span> </div>
116 <div class=
"line"><a name=
"l00025"></a><span class=
"lineno"> 25</span> <span class=
"keyword">namespace
</span><a class=
"code" href=
"namespaceboost.html">boost
</a> {
</div>
117 <div class=
"line"><a name=
"l00026"></a><span class=
"lineno"> 26</span> <span class=
"keyword">namespace
</span>sort {
</div>
118 <div class=
"line"><a name=
"l00027"></a><span class=
"lineno"> 27</span> <span class=
"comment"></span></div>
119 <div class=
"line"><a name=
"l00028"></a><span class=
"lineno"> 28</span> <span class=
"comment">/*! \brief String sort algorithm using random access iterators, allowing character-type overloads.\n
</span></div>
120 <div class=
"line"><a name=
"l00029"></a><span class=
"lineno"> 29</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< @c detail::min_sort_size).
</span></div>
121 <div class=
"line"><a name=
"l00030"></a><span class=
"lineno"> 30</span> <span class=
"comment"></span></div>
122 <div class=
"line"><a name=
"l00031"></a><span class=
"lineno"> 31</span> <span class=
"comment"> \details @c string_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
123 <div class=
"line"><a name=
"l00032"></a><span class=
"lineno"> 32</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
124 <div class=
"line"><a name=
"l00033"></a><span class=
"lineno"> 33</span> <span class=
"comment">\par
</span></div>
125 <div class=
"line"><a name=
"l00034"></a><span class=
"lineno"> 34</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
126 <div class=
"line"><a name=
"l00035"></a><span class=
"lineno"> 35</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
127 <div class=
"line"><a name=
"l00036"></a><span class=
"lineno"> 36</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
128 <div class=
"line"><a name=
"l00037"></a><span class=
"lineno"> 37</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
129 <div class=
"line"><a name=
"l00038"></a><span class=
"lineno"> 38</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
130 <div class=
"line"><a name=
"l00039"></a><span class=
"lineno"> 39</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
131 <div class=
"line"><a name=
"l00040"></a><span class=
"lineno"> 40</span> <span class=
"comment"><a href=
"../../doc/graph/windows_string_sort.htm
"> windows_string_sort
</a
>\n
</span></div>
132 <div class=
"line"><a name=
"l00041"></a><span class=
"lineno"> 41</span> <span class=
"comment"><a href=
"../../doc/graph/osx_string_sort.htm
"> osx_string_sort
</a
></span></div>
133 <div class=
"line"><a name=
"l00042"></a><span class=
"lineno"> 42</span> <span class=
"comment"></span></div>
134 <div class=
"line"><a name=
"l00043"></a><span class=
"lineno"> 43</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
135 <div class=
"line"><a name=
"l00044"></a><span class=
"lineno"> 44</span> <span class=
"comment"> \tparam Unsigned_char_type Unsigned character type used for string.
</span></div>
136 <div class=
"line"><a name=
"l00045"></a><span class=
"lineno"> 45</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
137 <div class=
"line"><a name=
"l00046"></a><span class=
"lineno"> 46</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
138 <div class=
"line"><a name=
"l00047"></a><span class=
"lineno"> 47</span> <span class=
"comment"> \param[in] unused Unused ???
</span></div>
139 <div class=
"line"><a name=
"l00048"></a><span class=
"lineno"> 48</span> <span class=
"comment"></span></div>
140 <div class=
"line"><a name=
"l00049"></a><span class=
"lineno"> 49</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
141 <div class=
"line"><a name=
"l00050"></a><span class=
"lineno"> 50</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
142 <div class=
"line"><a name=
"l00051"></a><span class=
"lineno"> 51</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
143 <div class=
"line"><a name=
"l00052"></a><span class=
"lineno"> 52</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type supports the @c operator
>>,
</span></div>
144 <div class=
"line"><a name=
"l00053"></a><span class=
"lineno"> 53</span> <span class=
"comment"> which returns an integer-type right-shifted a specified number of bits.
</span></div>
145 <div class=
"line"><a name=
"l00054"></a><span class=
"lineno"> 54</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
146 <div class=
"line"><a name=
"l00055"></a><span class=
"lineno"> 55</span> <span class=
"comment"></span></div>
147 <div class=
"line"><a name=
"l00056"></a><span class=
"lineno"> 56</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
148 <div class=
"line"><a name=
"l00057"></a><span class=
"lineno"> 57</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
149 <div class=
"line"><a name=
"l00058"></a><span class=
"lineno"> 58</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
150 <div class=
"line"><a name=
"l00059"></a><span class=
"lineno"> 59</span> <span class=
"comment"></span></div>
151 <div class=
"line"><a name=
"l00060"></a><span class=
"lineno"> 60</span> <span class=
"comment"> \warning 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.
</span></div>
152 <div class=
"line"><a name=
"l00061"></a><span class=
"lineno"> 61</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
153 <div class=
"line"><a name=
"l00062"></a><span class=
"lineno"> 62</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
154 <div class=
"line"><a name=
"l00063"></a><span class=
"lineno"> 63</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
155 <div class=
"line"><a name=
"l00064"></a><span class=
"lineno"> 64</span> <span class=
"comment"></span></div>
156 <div class=
"line"><a name=
"l00065"></a><span class=
"lineno"> 65</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
157 <div class=
"line"><a name=
"l00066"></a><span class=
"lineno"> 66</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
158 <div class=
"line"><a name=
"l00067"></a><span class=
"lineno"> 67</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
159 <div class=
"line"><a name=
"l00068"></a><span class=
"lineno"> 68</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
160 <div class=
"line"><a name=
"l00069"></a><span class=
"lineno"> 69</span> <span class=
"comment"></span></div>
161 <div class=
"line"><a name=
"l00070"></a><span class=
"lineno"> 70</span> <span class=
"comment">*/
</span></div>
162 <div class=
"line"><a name=
"l00071"></a><span class=
"lineno"> 71</span> </div>
163 <div class=
"line"><a name=
"l00072"></a><span class=
"lineno"> 72</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span> RandomAccessIter,
<span class=
"keyword">class
</span> Un
<span class=
"keywordtype">signed
</span>_
<span class=
"keywordtype">char
</span>_type
></div>
164 <div class=
"line"><a name=
"l00073"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0"> 73</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">string_sort
</a>(RandomAccessIter first, RandomAccessIter last,
</div>
165 <div class=
"line"><a name=
"l00074"></a><span class=
"lineno"> 74</span>  Unsigned_char_type unused)
</div>
166 <div class=
"line"><a name=
"l00075"></a><span class=
"lineno"> 75</span>  {
</div>
167 <div class=
"line"><a name=
"l00076"></a><span class=
"lineno"> 76</span>  <span class=
"comment">//Don
't sort if it
's too small to optimize
</span></div>
168 <div class=
"line"><a name=
"l00077"></a><span class=
"lineno"> 77</span>  <span class=
"keywordflow">if
</span> (last - first
< detail::min_sort_size)
</div>
169 <div class=
"line"><a name=
"l00078"></a><span class=
"lineno"> 78</span>  std::sort(first, last);
</div>
170 <div class=
"line"><a name=
"l00079"></a><span class=
"lineno"> 79</span>  <span class=
"keywordflow">else
</span></div>
171 <div class=
"line"><a name=
"l00080"></a><span class=
"lineno"> 80</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a82c4c0d7ba9873ecce7c674631dceae2">detail::string_sort
</a>(first, last, unused);
</div>
172 <div class=
"line"><a name=
"l00081"></a><span class=
"lineno"> 81</span>  }
</div>
173 <div class=
"line"><a name=
"l00082"></a><span class=
"lineno"> 82</span> </div>
174 <div class=
"line"><a name=
"l00083"></a><span class=
"lineno"> 83</span> <span class=
"comment"></span></div>
175 <div class=
"line"><a name=
"l00084"></a><span class=
"lineno"> 84</span> <span class=
"comment">/*! \brief String sort algorithm using random access iterators, wraps using default of unsigned char.
</span></div>
176 <div class=
"line"><a name=
"l00085"></a><span class=
"lineno"> 85</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< @c detail::min_sort_size).
</span></div>
177 <div class=
"line"><a name=
"l00086"></a><span class=
"lineno"> 86</span> <span class=
"comment"></span></div>
178 <div class=
"line"><a name=
"l00087"></a><span class=
"lineno"> 87</span> <span class=
"comment"> \details @c string_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
179 <div class=
"line"><a name=
"l00088"></a><span class=
"lineno"> 88</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
180 <div class=
"line"><a name=
"l00089"></a><span class=
"lineno"> 89</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
181 <div class=
"line"><a name=
"l00090"></a><span class=
"lineno"> 90</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
182 <div class=
"line"><a name=
"l00091"></a><span class=
"lineno"> 91</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
183 <div class=
"line"><a name=
"l00092"></a><span class=
"lineno"> 92</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
184 <div class=
"line"><a name=
"l00093"></a><span class=
"lineno"> 93</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
185 <div class=
"line"><a name=
"l00094"></a><span class=
"lineno"> 94</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
186 <div class=
"line"><a name=
"l00095"></a><span class=
"lineno"> 95</span> <span class=
"comment"> <a href=
"../../doc/graph/windows_string_sort.htm
"> windows_string_sort
</a
></span></div>
187 <div class=
"line"><a name=
"l00096"></a><span class=
"lineno"> 96</span> <span class=
"comment"> \n
</span></div>
188 <div class=
"line"><a name=
"l00097"></a><span class=
"lineno"> 97</span> <span class=
"comment"> <a href=
"../../doc/graph/osx_string_sort.htm
"> osx_string_sort
</a
></span></div>
189 <div class=
"line"><a name=
"l00098"></a><span class=
"lineno"> 98</span> <span class=
"comment"></span></div>
190 <div class=
"line"><a name=
"l00099"></a><span class=
"lineno"> 99</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
191 <div class=
"line"><a name=
"l00100"></a><span class=
"lineno"> 100</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
192 <div class=
"line"><a name=
"l00101"></a><span class=
"lineno"> 101</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
193 <div class=
"line"><a name=
"l00102"></a><span class=
"lineno"> 102</span> <span class=
"comment"></span></div>
194 <div class=
"line"><a name=
"l00103"></a><span class=
"lineno"> 103</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
195 <div class=
"line"><a name=
"l00104"></a><span class=
"lineno"> 104</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
196 <div class=
"line"><a name=
"l00105"></a><span class=
"lineno"> 105</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
197 <div class=
"line"><a name=
"l00106"></a><span class=
"lineno"> 106</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type supports the @c operator
>>,
</span></div>
198 <div class=
"line"><a name=
"l00107"></a><span class=
"lineno"> 107</span> <span class=
"comment"> which returns an integer-type right-shifted a specified number of bits.
</span></div>
199 <div class=
"line"><a name=
"l00108"></a><span class=
"lineno"> 108</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
200 <div class=
"line"><a name=
"l00109"></a><span class=
"lineno"> 109</span> <span class=
"comment"></span></div>
201 <div class=
"line"><a name=
"l00110"></a><span class=
"lineno"> 110</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
202 <div class=
"line"><a name=
"l00111"></a><span class=
"lineno"> 111</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
203 <div class=
"line"><a name=
"l00112"></a><span class=
"lineno"> 112</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
204 <div class=
"line"><a name=
"l00113"></a><span class=
"lineno"> 113</span> <span class=
"comment"></span></div>
205 <div class=
"line"><a name=
"l00114"></a><span class=
"lineno"> 114</span> <span class=
"comment"> \warning 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.
</span></div>
206 <div class=
"line"><a name=
"l00115"></a><span class=
"lineno"> 115</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
207 <div class=
"line"><a name=
"l00116"></a><span class=
"lineno"> 116</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
208 <div class=
"line"><a name=
"l00117"></a><span class=
"lineno"> 117</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
209 <div class=
"line"><a name=
"l00118"></a><span class=
"lineno"> 118</span> <span class=
"comment"></span></div>
210 <div class=
"line"><a name=
"l00119"></a><span class=
"lineno"> 119</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
211 <div class=
"line"><a name=
"l00120"></a><span class=
"lineno"> 120</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
212 <div class=
"line"><a name=
"l00121"></a><span class=
"lineno"> 121</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
213 <div class=
"line"><a name=
"l00122"></a><span class=
"lineno"> 122</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
214 <div class=
"line"><a name=
"l00123"></a><span class=
"lineno"> 123</span> <span class=
"comment"></span></div>
215 <div class=
"line"><a name=
"l00124"></a><span class=
"lineno"> 124</span> <span class=
"comment">*/
</span></div>
216 <div class=
"line"><a name=
"l00125"></a><span class=
"lineno"> 125</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span> RandomAccessIter
></div>
217 <div class=
"line"><a name=
"l00126"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#a6acd5fc94521b0a5cb47dc491b6d862f"> 126</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">string_sort
</a>(RandomAccessIter first, RandomAccessIter last)
</div>
218 <div class=
"line"><a name=
"l00127"></a><span class=
"lineno"> 127</span>  {
</div>
219 <div class=
"line"><a name=
"l00128"></a><span class=
"lineno"> 128</span>  <span class=
"keywordtype">unsigned
</span> <span class=
"keywordtype">char
</span> unused =
<span class=
"charliteral">'\
0'</span>;
</div>
220 <div class=
"line"><a name=
"l00129"></a><span class=
"lineno"> 129</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">string_sort
</a>(first, last, unused);
</div>
221 <div class=
"line"><a name=
"l00130"></a><span class=
"lineno"> 130</span>  }
</div>
222 <div class=
"line"><a name=
"l00131"></a><span class=
"lineno"> 131</span> </div>
223 <div class=
"line"><a name=
"l00132"></a><span class=
"lineno"> 132</span> <span class=
"comment"></span></div>
224 <div class=
"line"><a name=
"l00133"></a><span class=
"lineno"> 133</span> <span class=
"comment">/*! \brief String sort algorithm using random access iterators, allowing character-type overloads.
</span></div>
225 <div class=
"line"><a name=
"l00134"></a><span class=
"lineno"> 134</span> <span class=
"comment"></span></div>
226 <div class=
"line"><a name=
"l00135"></a><span class=
"lineno"> 135</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< detail::min_sort_size).
</span></div>
227 <div class=
"line"><a name=
"l00136"></a><span class=
"lineno"> 136</span> <span class=
"comment"></span></div>
228 <div class=
"line"><a name=
"l00137"></a><span class=
"lineno"> 137</span> <span class=
"comment"> \details @c integer_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
229 <div class=
"line"><a name=
"l00138"></a><span class=
"lineno"> 138</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
230 <div class=
"line"><a name=
"l00139"></a><span class=
"lineno"> 139</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
231 <div class=
"line"><a name=
"l00140"></a><span class=
"lineno"> 140</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
232 <div class=
"line"><a name=
"l00141"></a><span class=
"lineno"> 141</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
233 <div class=
"line"><a name=
"l00142"></a><span class=
"lineno"> 142</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
234 <div class=
"line"><a name=
"l00143"></a><span class=
"lineno"> 143</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
235 <div class=
"line"><a name=
"l00144"></a><span class=
"lineno"> 144</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
236 <div class=
"line"><a name=
"l00145"></a><span class=
"lineno"> 145</span> <span class=
"comment"> <a href=
"../../doc/graph/windows_integer_sort.htm
"> windows_integer_sort
</a
></span></div>
237 <div class=
"line"><a name=
"l00146"></a><span class=
"lineno"> 146</span> <span class=
"comment"> \n
</span></div>
238 <div class=
"line"><a name=
"l00147"></a><span class=
"lineno"> 147</span> <span class=
"comment"> <a href=
"../../doc/graph/osx_integer_sort.htm
"> osx_integer_sort
</a
></span></div>
239 <div class=
"line"><a name=
"l00148"></a><span class=
"lineno"> 148</span> <span class=
"comment"></span></div>
240 <div class=
"line"><a name=
"l00149"></a><span class=
"lineno"> 149</span> <span class=
"comment"></span></div>
241 <div class=
"line"><a name=
"l00150"></a><span class=
"lineno"> 150</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
242 <div class=
"line"><a name=
"l00151"></a><span class=
"lineno"> 151</span> <span class=
"comment"> \tparam Comp To provide @c operator
< for user-defined comparison.
</span></div>
243 <div class=
"line"><a name=
"l00152"></a><span class=
"lineno"> 152</span> <span class=
"comment"> \tparam Unsigned_char_type Unsigned character type used for string.
</span></div>
244 <div class=
"line"><a name=
"l00153"></a><span class=
"lineno"> 153</span> <span class=
"comment"></span></div>
245 <div class=
"line"><a name=
"l00154"></a><span class=
"lineno"> 154</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
246 <div class=
"line"><a name=
"l00155"></a><span class=
"lineno"> 155</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
247 <div class=
"line"><a name=
"l00156"></a><span class=
"lineno"> 156</span> <span class=
"comment"> \param[in] comp comparison functor.
</span></div>
248 <div class=
"line"><a name=
"l00157"></a><span class=
"lineno"> 157</span> <span class=
"comment"> \param[in] unused Unused ???
</span></div>
249 <div class=
"line"><a name=
"l00158"></a><span class=
"lineno"> 158</span> <span class=
"comment"></span></div>
250 <div class=
"line"><a name=
"l00159"></a><span class=
"lineno"> 159</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
251 <div class=
"line"><a name=
"l00160"></a><span class=
"lineno"> 160</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
252 <div class=
"line"><a name=
"l00161"></a><span class=
"lineno"> 161</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
253 <div class=
"line"><a name=
"l00162"></a><span class=
"lineno"> 162</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type supports the @c operator
>>,
</span></div>
254 <div class=
"line"><a name=
"l00163"></a><span class=
"lineno"> 163</span> <span class=
"comment"> which returns an integer-type right-shifted a specified number of bits.
</span></div>
255 <div class=
"line"><a name=
"l00164"></a><span class=
"lineno"> 164</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
256 <div class=
"line"><a name=
"l00165"></a><span class=
"lineno"> 165</span> <span class=
"comment"></span></div>
257 <div class=
"line"><a name=
"l00166"></a><span class=
"lineno"> 166</span> <span class=
"comment"> \return @c void.
</span></div>
258 <div class=
"line"><a name=
"l00167"></a><span class=
"lineno"> 167</span> <span class=
"comment"></span></div>
259 <div class=
"line"><a name=
"l00168"></a><span class=
"lineno"> 168</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
260 <div class=
"line"><a name=
"l00169"></a><span class=
"lineno"> 169</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
261 <div class=
"line"><a name=
"l00170"></a><span class=
"lineno"> 170</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
262 <div class=
"line"><a name=
"l00171"></a><span class=
"lineno"> 171</span> <span class=
"comment"></span></div>
263 <div class=
"line"><a name=
"l00172"></a><span class=
"lineno"> 172</span> <span class=
"comment"> \warning 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.
</span></div>
264 <div class=
"line"><a name=
"l00173"></a><span class=
"lineno"> 173</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
265 <div class=
"line"><a name=
"l00174"></a><span class=
"lineno"> 174</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
266 <div class=
"line"><a name=
"l00175"></a><span class=
"lineno"> 175</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
267 <div class=
"line"><a name=
"l00176"></a><span class=
"lineno"> 176</span> <span class=
"comment"></span></div>
268 <div class=
"line"><a name=
"l00177"></a><span class=
"lineno"> 177</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
269 <div class=
"line"><a name=
"l00178"></a><span class=
"lineno"> 178</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
270 <div class=
"line"><a name=
"l00179"></a><span class=
"lineno"> 179</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
271 <div class=
"line"><a name=
"l00180"></a><span class=
"lineno"> 180</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
272 <div class=
"line"><a name=
"l00181"></a><span class=
"lineno"> 181</span> <span class=
"comment">*/
</span></div>
273 <div class=
"line"><a name=
"l00182"></a><span class=
"lineno"> 182</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span> RandomAccessIter,
<span class=
"keyword">class
</span> Compare,
<span class=
"keyword">class
</span> Un
<span class=
"keywordtype">signed
</span>_
<span class=
"keywordtype">char
</span>_type
></div>
274 <div class=
"line"><a name=
"l00183"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48"> 183</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48">reverse_string_sort
</a>(RandomAccessIter first,
</div>
275 <div class=
"line"><a name=
"l00184"></a><span class=
"lineno"> 184</span>  RandomAccessIter last, Compare comp, Unsigned_char_type unused)
</div>
276 <div class=
"line"><a name=
"l00185"></a><span class=
"lineno"> 185</span>  {
</div>
277 <div class=
"line"><a name=
"l00186"></a><span class=
"lineno"> 186</span>  <span class=
"comment">//Don
't sort if it
's too small to optimize.
</span></div>
278 <div class=
"line"><a name=
"l00187"></a><span class=
"lineno"> 187</span>  <span class=
"keywordflow">if
</span> (last - first
< detail::min_sort_size)
</div>
279 <div class=
"line"><a name=
"l00188"></a><span class=
"lineno"> 188</span>  std::sort(first, last, comp);
</div>
280 <div class=
"line"><a name=
"l00189"></a><span class=
"lineno"> 189</span>  <span class=
"keywordflow">else
</span></div>
281 <div class=
"line"><a name=
"l00190"></a><span class=
"lineno"> 190</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a7940f1b2a7746c083a12a4e26077096b">detail::reverse_string_sort
</a>(first, last, unused);
</div>
282 <div class=
"line"><a name=
"l00191"></a><span class=
"lineno"> 191</span>  }
</div>
283 <div class=
"line"><a name=
"l00192"></a><span class=
"lineno"> 192</span> </div>
284 <div class=
"line"><a name=
"l00193"></a><span class=
"lineno"> 193</span> <span class=
"comment"></span></div>
285 <div class=
"line"><a name=
"l00194"></a><span class=
"lineno"> 194</span> <span class=
"comment">/*! \brief String sort algorithm using random access iterators, wraps using default of @c unsigned char.
</span></div>
286 <div class=
"line"><a name=
"l00195"></a><span class=
"lineno"> 195</span> <span class=
"comment"></span></div>
287 <div class=
"line"><a name=
"l00196"></a><span class=
"lineno"> 196</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< @c detail::min_sort_size).
</span></div>
288 <div class=
"line"><a name=
"l00197"></a><span class=
"lineno"> 197</span> <span class=
"comment"></span></div>
289 <div class=
"line"><a name=
"l00198"></a><span class=
"lineno"> 198</span> <span class=
"comment"> \details @c integer_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
290 <div class=
"line"><a name=
"l00199"></a><span class=
"lineno"> 199</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
291 <div class=
"line"><a name=
"l00200"></a><span class=
"lineno"> 200</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
292 <div class=
"line"><a name=
"l00201"></a><span class=
"lineno"> 201</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
293 <div class=
"line"><a name=
"l00202"></a><span class=
"lineno"> 202</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
294 <div class=
"line"><a name=
"l00203"></a><span class=
"lineno"> 203</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
295 <div class=
"line"><a name=
"l00204"></a><span class=
"lineno"> 204</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
296 <div class=
"line"><a name=
"l00205"></a><span class=
"lineno"> 205</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
297 <div class=
"line"><a name=
"l00206"></a><span class=
"lineno"> 206</span> <span class=
"comment"> <a href=
"../../doc/graph/windows_integer_sort.htm
"> windows_integer_sort
</a
></span></div>
298 <div class=
"line"><a name=
"l00207"></a><span class=
"lineno"> 207</span> <span class=
"comment"> \n
</span></div>
299 <div class=
"line"><a name=
"l00208"></a><span class=
"lineno"> 208</span> <span class=
"comment"> <a href=
"../../doc/graph/osx_integer_sort.htm
"> osx_integer_sort
</a
></span></div>
300 <div class=
"line"><a name=
"l00209"></a><span class=
"lineno"> 209</span> <span class=
"comment"></span></div>
301 <div class=
"line"><a name=
"l00210"></a><span class=
"lineno"> 210</span> <span class=
"comment"></span></div>
302 <div class=
"line"><a name=
"l00211"></a><span class=
"lineno"> 211</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
303 <div class=
"line"><a name=
"l00212"></a><span class=
"lineno"> 212</span> <span class=
"comment"> \tparam Comp To provide @c operator
< for user-defined comparison.
</span></div>
304 <div class=
"line"><a name=
"l00213"></a><span class=
"lineno"> 213</span> <span class=
"comment"></span></div>
305 <div class=
"line"><a name=
"l00214"></a><span class=
"lineno"> 214</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
306 <div class=
"line"><a name=
"l00215"></a><span class=
"lineno"> 215</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
307 <div class=
"line"><a name=
"l00216"></a><span class=
"lineno"> 216</span> <span class=
"comment"> \param[in] comp Comparison functor.
</span></div>
308 <div class=
"line"><a name=
"l00217"></a><span class=
"lineno"> 217</span> <span class=
"comment"></span></div>
309 <div class=
"line"><a name=
"l00218"></a><span class=
"lineno"> 218</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
310 <div class=
"line"><a name=
"l00219"></a><span class=
"lineno"> 219</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
311 <div class=
"line"><a name=
"l00220"></a><span class=
"lineno"> 220</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
312 <div class=
"line"><a name=
"l00221"></a><span class=
"lineno"> 221</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type supports the @c operator
>>,
</span></div>
313 <div class=
"line"><a name=
"l00222"></a><span class=
"lineno"> 222</span> <span class=
"comment"> which returns an integer-type right-shifted a specified number of bits.
</span></div>
314 <div class=
"line"><a name=
"l00223"></a><span class=
"lineno"> 223</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
315 <div class=
"line"><a name=
"l00224"></a><span class=
"lineno"> 224</span> <span class=
"comment"></span></div>
316 <div class=
"line"><a name=
"l00225"></a><span class=
"lineno"> 225</span> <span class=
"comment"> \return @c void.
</span></div>
317 <div class=
"line"><a name=
"l00226"></a><span class=
"lineno"> 226</span> <span class=
"comment"></span></div>
318 <div class=
"line"><a name=
"l00227"></a><span class=
"lineno"> 227</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
319 <div class=
"line"><a name=
"l00228"></a><span class=
"lineno"> 228</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
320 <div class=
"line"><a name=
"l00229"></a><span class=
"lineno"> 229</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
321 <div class=
"line"><a name=
"l00230"></a><span class=
"lineno"> 230</span> <span class=
"comment"></span></div>
322 <div class=
"line"><a name=
"l00231"></a><span class=
"lineno"> 231</span> <span class=
"comment"> \warning 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.
</span></div>
323 <div class=
"line"><a name=
"l00232"></a><span class=
"lineno"> 232</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
324 <div class=
"line"><a name=
"l00233"></a><span class=
"lineno"> 233</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
325 <div class=
"line"><a name=
"l00234"></a><span class=
"lineno"> 234</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
326 <div class=
"line"><a name=
"l00235"></a><span class=
"lineno"> 235</span> <span class=
"comment"></span></div>
327 <div class=
"line"><a name=
"l00236"></a><span class=
"lineno"> 236</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
328 <div class=
"line"><a name=
"l00237"></a><span class=
"lineno"> 237</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
329 <div class=
"line"><a name=
"l00238"></a><span class=
"lineno"> 238</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
330 <div class=
"line"><a name=
"l00239"></a><span class=
"lineno"> 239</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
331 <div class=
"line"><a name=
"l00240"></a><span class=
"lineno"> 240</span> <span class=
"comment">*/
</span></div>
332 <div class=
"line"><a name=
"l00241"></a><span class=
"lineno"> 241</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span> RandomAccessIter,
<span class=
"keyword">class
</span> Compare
></div>
333 <div class=
"line"><a name=
"l00242"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#afd4938835fd03aab9c42bd0653e5dbe5"> 242</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48">reverse_string_sort
</a>(RandomAccessIter first,
</div>
334 <div class=
"line"><a name=
"l00243"></a><span class=
"lineno"> 243</span>  RandomAccessIter last, Compare comp)
</div>
335 <div class=
"line"><a name=
"l00244"></a><span class=
"lineno"> 244</span>  {
</div>
336 <div class=
"line"><a name=
"l00245"></a><span class=
"lineno"> 245</span>  <span class=
"keywordtype">unsigned
</span> <span class=
"keywordtype">char
</span> unused =
<span class=
"charliteral">'\
0'</span>;
</div>
337 <div class=
"line"><a name=
"l00246"></a><span class=
"lineno"> 246</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48">reverse_string_sort
</a>(first, last, comp, unused);
</div>
338 <div class=
"line"><a name=
"l00247"></a><span class=
"lineno"> 247</span>  }
</div>
339 <div class=
"line"><a name=
"l00248"></a><span class=
"lineno"> 248</span> </div>
340 <div class=
"line"><a name=
"l00249"></a><span class=
"lineno"> 249</span> <span class=
"comment"></span></div>
341 <div class=
"line"><a name=
"l00250"></a><span class=
"lineno"> 250</span> <span class=
"comment">/*! \brief String sort algorithm using random access iterators, wraps using default of @c unsigned char.
</span></div>
342 <div class=
"line"><a name=
"l00251"></a><span class=
"lineno"> 251</span> <span class=
"comment"></span></div>
343 <div class=
"line"><a name=
"l00252"></a><span class=
"lineno"> 252</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< @c detail::min_sort_size).
</span></div>
344 <div class=
"line"><a name=
"l00253"></a><span class=
"lineno"> 253</span> <span class=
"comment"></span></div>
345 <div class=
"line"><a name=
"l00254"></a><span class=
"lineno"> 254</span> <span class=
"comment"> \details @c integer_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
346 <div class=
"line"><a name=
"l00255"></a><span class=
"lineno"> 255</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
347 <div class=
"line"><a name=
"l00256"></a><span class=
"lineno"> 256</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
348 <div class=
"line"><a name=
"l00257"></a><span class=
"lineno"> 257</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
349 <div class=
"line"><a name=
"l00258"></a><span class=
"lineno"> 258</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
350 <div class=
"line"><a name=
"l00259"></a><span class=
"lineno"> 259</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
351 <div class=
"line"><a name=
"l00260"></a><span class=
"lineno"> 260</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
352 <div class=
"line"><a name=
"l00261"></a><span class=
"lineno"> 261</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
353 <div class=
"line"><a name=
"l00262"></a><span class=
"lineno"> 262</span> <span class=
"comment"> <a href=
"../../doc/graph/windows_integer_sort.htm
"> windows_integer_sort
</a
></span></div>
354 <div class=
"line"><a name=
"l00263"></a><span class=
"lineno"> 263</span> <span class=
"comment"> \n
</span></div>
355 <div class=
"line"><a name=
"l00264"></a><span class=
"lineno"> 264</span> <span class=
"comment"> <a href=
"../../doc/graph/osx_integer_sort.htm
"> osx_integer_sort
</a
></span></div>
356 <div class=
"line"><a name=
"l00265"></a><span class=
"lineno"> 265</span> <span class=
"comment"></span></div>
357 <div class=
"line"><a name=
"l00266"></a><span class=
"lineno"> 266</span> <span class=
"comment"></span></div>
358 <div class=
"line"><a name=
"l00267"></a><span class=
"lineno"> 267</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
359 <div class=
"line"><a name=
"l00268"></a><span class=
"lineno"> 268</span> <span class=
"comment"> \tparam Get_char Bracket functor equivalent to @c operator[], taking a number corresponding to the character offset..
</span></div>
360 <div class=
"line"><a name=
"l00269"></a><span class=
"lineno"> 269</span> <span class=
"comment"> \tparam Get_length Functor to get the length of the string in characters. TODO Check this and below and other places!!!
</span></div>
361 <div class=
"line"><a name=
"l00270"></a><span class=
"lineno"> 270</span> <span class=
"comment"></span></div>
362 <div class=
"line"><a name=
"l00271"></a><span class=
"lineno"> 271</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
363 <div class=
"line"><a name=
"l00272"></a><span class=
"lineno"> 272</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
364 <div class=
"line"><a name=
"l00273"></a><span class=
"lineno"> 273</span> <span class=
"comment"> \param[in] getchar Number corresponding to the character offset from bracket functor equivalent to @c operator[].
</span></div>
365 <div class=
"line"><a name=
"l00274"></a><span class=
"lineno"> 274</span> <span class=
"comment"> \param[in] length Functor to get the length of the string in characters.
</span></div>
366 <div class=
"line"><a name=
"l00275"></a><span class=
"lineno"> 275</span> <span class=
"comment"></span></div>
367 <div class=
"line"><a name=
"l00276"></a><span class=
"lineno"> 276</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
368 <div class=
"line"><a name=
"l00277"></a><span class=
"lineno"> 277</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
369 <div class=
"line"><a name=
"l00278"></a><span class=
"lineno"> 278</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
370 <div class=
"line"><a name=
"l00279"></a><span class=
"lineno"> 279</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type supports the @c operator
>>,
</span></div>
371 <div class=
"line"><a name=
"l00280"></a><span class=
"lineno"> 280</span> <span class=
"comment"> which returns an integer-type right-shifted a specified number of bits.
</span></div>
372 <div class=
"line"><a name=
"l00281"></a><span class=
"lineno"> 281</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
373 <div class=
"line"><a name=
"l00282"></a><span class=
"lineno"> 282</span> <span class=
"comment"></span></div>
374 <div class=
"line"><a name=
"l00283"></a><span class=
"lineno"> 283</span> <span class=
"comment"> \return @c void.
</span></div>
375 <div class=
"line"><a name=
"l00284"></a><span class=
"lineno"> 284</span> <span class=
"comment"></span></div>
376 <div class=
"line"><a name=
"l00285"></a><span class=
"lineno"> 285</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
377 <div class=
"line"><a name=
"l00286"></a><span class=
"lineno"> 286</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
378 <div class=
"line"><a name=
"l00287"></a><span class=
"lineno"> 287</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
379 <div class=
"line"><a name=
"l00288"></a><span class=
"lineno"> 288</span> <span class=
"comment"></span></div>
380 <div class=
"line"><a name=
"l00289"></a><span class=
"lineno"> 289</span> <span class=
"comment"> \warning 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.
</span></div>
381 <div class=
"line"><a name=
"l00290"></a><span class=
"lineno"> 290</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
382 <div class=
"line"><a name=
"l00291"></a><span class=
"lineno"> 291</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
383 <div class=
"line"><a name=
"l00292"></a><span class=
"lineno"> 292</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
384 <div class=
"line"><a name=
"l00293"></a><span class=
"lineno"> 293</span> <span class=
"comment"></span></div>
385 <div class=
"line"><a name=
"l00294"></a><span class=
"lineno"> 294</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
386 <div class=
"line"><a name=
"l00295"></a><span class=
"lineno"> 295</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
387 <div class=
"line"><a name=
"l00296"></a><span class=
"lineno"> 296</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
388 <div class=
"line"><a name=
"l00297"></a><span class=
"lineno"> 297</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
389 <div class=
"line"><a name=
"l00298"></a><span class=
"lineno"> 298</span> <span class=
"comment"></span></div>
390 <div class=
"line"><a name=
"l00299"></a><span class=
"lineno"> 299</span> <span class=
"comment">*/
</span></div>
391 <div class=
"line"><a name=
"l00300"></a><span class=
"lineno"> 300</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span> RandomAccessIter,
<span class=
"keyword">class
</span> Get_
<span class=
"keywordtype">char
</span>,
<span class=
"keyword">class
</span> Get_length
></div>
392 <div class=
"line"><a name=
"l00301"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#a5143ec4f58cfe13eca2a0d6b6f6a6680"> 301</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">string_sort
</a>(RandomAccessIter first, RandomAccessIter last,
</div>
393 <div class=
"line"><a name=
"l00302"></a><span class=
"lineno"> 302</span>  Get_char getchar, Get_length length)
</div>
394 <div class=
"line"><a name=
"l00303"></a><span class=
"lineno"> 303</span>  {
</div>
395 <div class=
"line"><a name=
"l00304"></a><span class=
"lineno"> 304</span>  <span class=
"comment">//Don
't sort if it
's too small to optimize
</span></div>
396 <div class=
"line"><a name=
"l00305"></a><span class=
"lineno"> 305</span>  <span class=
"keywordflow">if
</span> (last - first
< detail::min_sort_size)
</div>
397 <div class=
"line"><a name=
"l00306"></a><span class=
"lineno"> 306</span>  std::sort(first, last);
</div>
398 <div class=
"line"><a name=
"l00307"></a><span class=
"lineno"> 307</span>  <span class=
"keywordflow">else
</span> {
</div>
399 <div class=
"line"><a name=
"l00308"></a><span class=
"lineno"> 308</span>  <span class=
"comment">//skipping past empties, which allows us to get the character type
</span></div>
400 <div class=
"line"><a name=
"l00309"></a><span class=
"lineno"> 309</span>  <span class=
"comment">//.empty() is not used so as not to require a user declaration of it
</span></div>
401 <div class=
"line"><a name=
"l00310"></a><span class=
"lineno"> 310</span>  <span class=
"keywordflow">while
</span> (!length(*first)) {
</div>
402 <div class=
"line"><a name=
"l00311"></a><span class=
"lineno"> 311</span>  <span class=
"keywordflow">if
</span> (++first == last)
</div>
403 <div class=
"line"><a name=
"l00312"></a><span class=
"lineno"> 312</span>  <span class=
"keywordflow">return
</span>;
</div>
404 <div class=
"line"><a name=
"l00313"></a><span class=
"lineno"> 313</span>  }
</div>
405 <div class=
"line"><a name=
"l00314"></a><span class=
"lineno"> 314</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a82c4c0d7ba9873ecce7c674631dceae2">detail::string_sort
</a>(first, last, getchar, length, getchar((*first),
0));
</div>
406 <div class=
"line"><a name=
"l00315"></a><span class=
"lineno"> 315</span>  }
</div>
407 <div class=
"line"><a name=
"l00316"></a><span class=
"lineno"> 316</span>  }
</div>
408 <div class=
"line"><a name=
"l00317"></a><span class=
"lineno"> 317</span> </div>
409 <div class=
"line"><a name=
"l00318"></a><span class=
"lineno"> 318</span> </div>
410 <div class=
"line"><a name=
"l00319"></a><span class=
"lineno"> 319</span> <span class=
"comment"></span></div>
411 <div class=
"line"><a name=
"l00320"></a><span class=
"lineno"> 320</span> <span class=
"comment">/*! \brief String sort algorithm using random access iterators, wraps using default of @c unsigned char.
</span></div>
412 <div class=
"line"><a name=
"l00321"></a><span class=
"lineno"> 321</span> <span class=
"comment"></span></div>
413 <div class=
"line"><a name=
"l00322"></a><span class=
"lineno"> 322</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< @c detail::min_sort_size).
</span></div>
414 <div class=
"line"><a name=
"l00323"></a><span class=
"lineno"> 323</span> <span class=
"comment"></span></div>
415 <div class=
"line"><a name=
"l00324"></a><span class=
"lineno"> 324</span> <span class=
"comment"> \details @c integer_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
416 <div class=
"line"><a name=
"l00325"></a><span class=
"lineno"> 325</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
417 <div class=
"line"><a name=
"l00326"></a><span class=
"lineno"> 326</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
418 <div class=
"line"><a name=
"l00327"></a><span class=
"lineno"> 327</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
419 <div class=
"line"><a name=
"l00328"></a><span class=
"lineno"> 328</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
420 <div class=
"line"><a name=
"l00329"></a><span class=
"lineno"> 329</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
421 <div class=
"line"><a name=
"l00330"></a><span class=
"lineno"> 330</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
422 <div class=
"line"><a name=
"l00331"></a><span class=
"lineno"> 331</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
423 <div class=
"line"><a name=
"l00332"></a><span class=
"lineno"> 332</span> <span class=
"comment"> <a href=
"../../doc/graph/windows_integer_sort.htm
"> windows_integer_sort
</a
></span></div>
424 <div class=
"line"><a name=
"l00333"></a><span class=
"lineno"> 333</span> <span class=
"comment"> \n
</span></div>
425 <div class=
"line"><a name=
"l00334"></a><span class=
"lineno"> 334</span> <span class=
"comment"> <a href=
"../../doc/graph/osx_integer_sort.htm
"> osx_integer_sort
</a
></span></div>
426 <div class=
"line"><a name=
"l00335"></a><span class=
"lineno"> 335</span> <span class=
"comment"></span></div>
427 <div class=
"line"><a name=
"l00336"></a><span class=
"lineno"> 336</span> <span class=
"comment"></span></div>
428 <div class=
"line"><a name=
"l00337"></a><span class=
"lineno"> 337</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
429 <div class=
"line"><a name=
"l00338"></a><span class=
"lineno"> 338</span> <span class=
"comment"> \tparam Get_char ???.
</span></div>
430 <div class=
"line"><a name=
"l00339"></a><span class=
"lineno"> 339</span> <span class=
"comment"> \tparam Get_length ??? TODO
</span></div>
431 <div class=
"line"><a name=
"l00340"></a><span class=
"lineno"> 340</span> <span class=
"comment"> \tparam Comp To provide @c operator
< for user-defined comparison.
</span></div>
432 <div class=
"line"><a name=
"l00341"></a><span class=
"lineno"> 341</span> <span class=
"comment"></span></div>
433 <div class=
"line"><a name=
"l00342"></a><span class=
"lineno"> 342</span> <span class=
"comment"></span></div>
434 <div class=
"line"><a name=
"l00343"></a><span class=
"lineno"> 343</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
435 <div class=
"line"><a name=
"l00344"></a><span class=
"lineno"> 344</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
436 <div class=
"line"><a name=
"l00345"></a><span class=
"lineno"> 345</span> <span class=
"comment"> \param[in] comp comparison functor.
</span></div>
437 <div class=
"line"><a name=
"l00346"></a><span class=
"lineno"> 346</span> <span class=
"comment"> \param[in] getchar ???
</span></div>
438 <div class=
"line"><a name=
"l00347"></a><span class=
"lineno"> 347</span> <span class=
"comment"> \param[in] length ???
</span></div>
439 <div class=
"line"><a name=
"l00348"></a><span class=
"lineno"> 348</span> <span class=
"comment"></span></div>
440 <div class=
"line"><a name=
"l00349"></a><span class=
"lineno"> 349</span> <span class=
"comment"></span></div>
441 <div class=
"line"><a name=
"l00350"></a><span class=
"lineno"> 350</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
442 <div class=
"line"><a name=
"l00351"></a><span class=
"lineno"> 351</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
443 <div class=
"line"><a name=
"l00352"></a><span class=
"lineno"> 352</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
444 <div class=
"line"><a name=
"l00353"></a><span class=
"lineno"> 353</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
445 <div class=
"line"><a name=
"l00354"></a><span class=
"lineno"> 354</span> <span class=
"comment"></span></div>
446 <div class=
"line"><a name=
"l00355"></a><span class=
"lineno"> 355</span> <span class=
"comment"> \return @c void.
</span></div>
447 <div class=
"line"><a name=
"l00356"></a><span class=
"lineno"> 356</span> <span class=
"comment"></span></div>
448 <div class=
"line"><a name=
"l00357"></a><span class=
"lineno"> 357</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
449 <div class=
"line"><a name=
"l00358"></a><span class=
"lineno"> 358</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
450 <div class=
"line"><a name=
"l00359"></a><span class=
"lineno"> 359</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
451 <div class=
"line"><a name=
"l00360"></a><span class=
"lineno"> 360</span> <span class=
"comment"></span></div>
452 <div class=
"line"><a name=
"l00361"></a><span class=
"lineno"> 361</span> <span class=
"comment"> \warning 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.
</span></div>
453 <div class=
"line"><a name=
"l00362"></a><span class=
"lineno"> 362</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
454 <div class=
"line"><a name=
"l00363"></a><span class=
"lineno"> 363</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
455 <div class=
"line"><a name=
"l00364"></a><span class=
"lineno"> 364</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
456 <div class=
"line"><a name=
"l00365"></a><span class=
"lineno"> 365</span> <span class=
"comment"></span></div>
457 <div class=
"line"><a name=
"l00366"></a><span class=
"lineno"> 366</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
458 <div class=
"line"><a name=
"l00367"></a><span class=
"lineno"> 367</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
459 <div class=
"line"><a name=
"l00368"></a><span class=
"lineno"> 368</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
460 <div class=
"line"><a name=
"l00369"></a><span class=
"lineno"> 369</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
461 <div class=
"line"><a name=
"l00370"></a><span class=
"lineno"> 370</span> <span class=
"comment"></span></div>
462 <div class=
"line"><a name=
"l00371"></a><span class=
"lineno"> 371</span> <span class=
"comment">*/
</span></div>
463 <div class=
"line"><a name=
"l00372"></a><span class=
"lineno"> 372</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span>RandomAccessIter,
<span class=
"keyword">class
</span>Get_char,
<span class=
"keyword">class
</span>Get_length,
</div>
464 <div class=
"line"><a name=
"l00373"></a><span class=
"lineno"> 373</span>  <span class=
"keyword">class
</span>Compare
></div>
465 <div class=
"line"><a name=
"l00374"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#a82c4c0d7ba9873ecce7c674631dceae2"> 374</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">string_sort
</a>(RandomAccessIter first, RandomAccessIter last,
</div>
466 <div class=
"line"><a name=
"l00375"></a><span class=
"lineno"> 375</span>  Get_char getchar, Get_length length, Compare comp)
</div>
467 <div class=
"line"><a name=
"l00376"></a><span class=
"lineno"> 376</span>  {
</div>
468 <div class=
"line"><a name=
"l00377"></a><span class=
"lineno"> 377</span>  <span class=
"comment">//Don
't sort if it
's too small to optimize
</span></div>
469 <div class=
"line"><a name=
"l00378"></a><span class=
"lineno"> 378</span>  <span class=
"keywordflow">if
</span> (last - first
< detail::min_sort_size)
</div>
470 <div class=
"line"><a name=
"l00379"></a><span class=
"lineno"> 379</span>  std::sort(first, last, comp);
</div>
471 <div class=
"line"><a name=
"l00380"></a><span class=
"lineno"> 380</span>  <span class=
"keywordflow">else
</span> {
</div>
472 <div class=
"line"><a name=
"l00381"></a><span class=
"lineno"> 381</span>  <span class=
"comment">//skipping past empties, which allows us to get the character type
</span></div>
473 <div class=
"line"><a name=
"l00382"></a><span class=
"lineno"> 382</span>  <span class=
"comment">//.empty() is not used so as not to require a user declaration of it
</span></div>
474 <div class=
"line"><a name=
"l00383"></a><span class=
"lineno"> 383</span>  <span class=
"keywordflow">while
</span> (!length(*first)) {
</div>
475 <div class=
"line"><a name=
"l00384"></a><span class=
"lineno"> 384</span>  <span class=
"keywordflow">if
</span> (++first == last)
</div>
476 <div class=
"line"><a name=
"l00385"></a><span class=
"lineno"> 385</span>  <span class=
"keywordflow">return
</span>;
</div>
477 <div class=
"line"><a name=
"l00386"></a><span class=
"lineno"> 386</span>  }
</div>
478 <div class=
"line"><a name=
"l00387"></a><span class=
"lineno"> 387</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a82c4c0d7ba9873ecce7c674631dceae2">detail::string_sort
</a>(first, last, getchar, length, comp,
</div>
479 <div class=
"line"><a name=
"l00388"></a><span class=
"lineno"> 388</span>  getchar((*first),
0));
</div>
480 <div class=
"line"><a name=
"l00389"></a><span class=
"lineno"> 389</span>  }
</div>
481 <div class=
"line"><a name=
"l00390"></a><span class=
"lineno"> 390</span>  }
</div>
482 <div class=
"line"><a name=
"l00391"></a><span class=
"lineno"> 391</span> </div>
483 <div class=
"line"><a name=
"l00392"></a><span class=
"lineno"> 392</span> <span class=
"comment"></span></div>
484 <div class=
"line"><a name=
"l00393"></a><span class=
"lineno"> 393</span> <span class=
"comment">/*! \brief Reverse String sort algorithm using random access iterators.
</span></div>
485 <div class=
"line"><a name=
"l00394"></a><span class=
"lineno"> 394</span> <span class=
"comment"></span></div>
486 <div class=
"line"><a name=
"l00395"></a><span class=
"lineno"> 395</span> <span class=
"comment"> (All variants fall back to @c std::sort if the data size is too small,
< @c detail::min_sort_size).
</span></div>
487 <div class=
"line"><a name=
"l00396"></a><span class=
"lineno"> 396</span> <span class=
"comment"></span></div>
488 <div class=
"line"><a name=
"l00397"></a><span class=
"lineno"> 397</span> <span class=
"comment"> \details @c integer_sort is a fast templated in-place hybrid radix/comparison algorithm,
</span></div>
489 <div class=
"line"><a name=
"l00398"></a><span class=
"lineno"> 398</span> <span class=
"comment">which in testing tends to be roughly
50% to
2X faster than @c std::sort for large tests (
>=
100kB).\n
</span></div>
490 <div class=
"line"><a name=
"l00399"></a><span class=
"lineno"> 399</span> <span class=
"comment">Worst-case performance is
<em
> O(N * (lg(range)/s + s))
</em
>,
</span></div>
491 <div class=
"line"><a name=
"l00400"></a><span class=
"lineno"> 400</span> <span class=
"comment">so @c integer_sort is asymptotically faster
</span></div>
492 <div class=
"line"><a name=
"l00401"></a><span class=
"lineno"> 401</span> <span class=
"comment">than pure comparison-based algorithms. @c s is @c max_splits, which defaults to
11,
</span></div>
493 <div class=
"line"><a name=
"l00402"></a><span class=
"lineno"> 402</span> <span class=
"comment">so its worst-case with default settings for
32-bit integers is
</span></div>
494 <div class=
"line"><a name=
"l00403"></a><span class=
"lineno"> 403</span> <span class=
"comment"><em
> O(N * ((
32/
11)
</em
> slow radix-based iterations fast comparison-based iterations).\n\n
</span></div>
495 <div class=
"line"><a name=
"l00404"></a><span class=
"lineno"> 404</span> <span class=
"comment">Some performance plots of runtime vs. n and log(range) are provided:\n
</span></div>
496 <div class=
"line"><a name=
"l00405"></a><span class=
"lineno"> 405</span> <span class=
"comment"> <a href=
"../../doc/graph/windows_integer_sort.htm
"> windows_integer_sort
</a
></span></div>
497 <div class=
"line"><a name=
"l00406"></a><span class=
"lineno"> 406</span> <span class=
"comment"> \n
</span></div>
498 <div class=
"line"><a name=
"l00407"></a><span class=
"lineno"> 407</span> <span class=
"comment"> <a href=
"../../doc/graph/osx_integer_sort.htm
"> osx_integer_sort
</a
></span></div>
499 <div class=
"line"><a name=
"l00408"></a><span class=
"lineno"> 408</span> <span class=
"comment"></span></div>
500 <div class=
"line"><a name=
"l00409"></a><span class=
"lineno"> 409</span> <span class=
"comment"></span></div>
501 <div class=
"line"><a name=
"l00410"></a><span class=
"lineno"> 410</span> <span class=
"comment"> \tparam RandomAccessIter
<a href=
"http://www.cplusplus.com/reference/iterator/RandomAccessIterator/
">Random access iterator
</a
></span></div>
502 <div class=
"line"><a name=
"l00411"></a><span class=
"lineno"> 411</span> <span class=
"comment"> \tparam Get_char ???.
</span></div>
503 <div class=
"line"><a name=
"l00412"></a><span class=
"lineno"> 412</span> <span class=
"comment"> \tparam Get_length ??? TODO
</span></div>
504 <div class=
"line"><a name=
"l00413"></a><span class=
"lineno"> 413</span> <span class=
"comment"> \tparam Comp To provide @c operator
< for user-defined comparison.
</span></div>
505 <div class=
"line"><a name=
"l00414"></a><span class=
"lineno"> 414</span> <span class=
"comment"></span></div>
506 <div class=
"line"><a name=
"l00415"></a><span class=
"lineno"> 415</span> <span class=
"comment"></span></div>
507 <div class=
"line"><a name=
"l00416"></a><span class=
"lineno"> 416</span> <span class=
"comment"> \param[in] first Iterator pointer to first element.
</span></div>
508 <div class=
"line"><a name=
"l00417"></a><span class=
"lineno"> 417</span> <span class=
"comment"> \param[in] last Iterator pointing to one beyond the end of data.
</span></div>
509 <div class=
"line"><a name=
"l00418"></a><span class=
"lineno"> 418</span> <span class=
"comment"> \param[in] comp comparison functor.
</span></div>
510 <div class=
"line"><a name=
"l00419"></a><span class=
"lineno"> 419</span> <span class=
"comment"> \param[in] getchar ???
</span></div>
511 <div class=
"line"><a name=
"l00420"></a><span class=
"lineno"> 420</span> <span class=
"comment"> \param[in] length ???
</span></div>
512 <div class=
"line"><a name=
"l00421"></a><span class=
"lineno"> 421</span> <span class=
"comment"></span></div>
513 <div class=
"line"><a name=
"l00422"></a><span class=
"lineno"> 422</span> <span class=
"comment"></span></div>
514 <div class=
"line"><a name=
"l00423"></a><span class=
"lineno"> 423</span> <span class=
"comment"> \pre [@c first, @c last) is a valid range.
</span></div>
515 <div class=
"line"><a name=
"l00424"></a><span class=
"lineno"> 424</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is mutable.
</span></div>
516 <div class=
"line"><a name=
"l00425"></a><span class=
"lineno"> 425</span> <span class=
"comment"> \pre @c RandomAccessIter @c value_type is
<a href=
"http://en.cppreference.com/w/cpp/concept/LessThanComparable
">LessThanComparable
</a
></span></div>
517 <div class=
"line"><a name=
"l00426"></a><span class=
"lineno"> 426</span> <span class=
"comment"> \post The elements in the range [@c first, @c last) are sorted in ascending order.
</span></div>
518 <div class=
"line"><a name=
"l00427"></a><span class=
"lineno"> 427</span> <span class=
"comment"></span></div>
519 <div class=
"line"><a name=
"l00428"></a><span class=
"lineno"> 428</span> <span class=
"comment"> \return @c void.
</span></div>
520 <div class=
"line"><a name=
"l00429"></a><span class=
"lineno"> 429</span> <span class=
"comment"></span></div>
521 <div class=
"line"><a name=
"l00430"></a><span class=
"lineno"> 430</span> <span class=
"comment"> \throws std::exception Propagates exceptions if any of the element comparisons, the element swaps (or moves),
</span></div>
522 <div class=
"line"><a name=
"l00431"></a><span class=
"lineno"> 431</span> <span class=
"comment"> the right shift, subtraction of right-shifted elements, functors,
</span></div>
523 <div class=
"line"><a name=
"l00432"></a><span class=
"lineno"> 432</span> <span class=
"comment"> or any operations on iterators throw.
</span></div>
524 <div class=
"line"><a name=
"l00433"></a><span class=
"lineno"> 433</span> <span class=
"comment"></span></div>
525 <div class=
"line"><a name=
"l00434"></a><span class=
"lineno"> 434</span> <span class=
"comment"> \warning 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.
</span></div>
526 <div class=
"line"><a name=
"l00435"></a><span class=
"lineno"> 435</span> <span class=
"comment"> \warning Invalid arguments cause undefined behaviour.
</span></div>
527 <div class=
"line"><a name=
"l00436"></a><span class=
"lineno"> 436</span> <span class=
"comment"> \note @c spreadsort function provides a wrapper that calls the fastest sorting algorithm available for a data type,
</span></div>
528 <div class=
"line"><a name=
"l00437"></a><span class=
"lineno"> 437</span> <span class=
"comment"> enabling faster generic-programming.
</span></div>
529 <div class=
"line"><a name=
"l00438"></a><span class=
"lineno"> 438</span> <span class=
"comment"></span></div>
530 <div class=
"line"><a name=
"l00439"></a><span class=
"lineno"> 439</span> <span class=
"comment"> \remark The lesser of
<em
> O(N*log(N))
</em
> comparisons and
<em
> O(N*log(K/S + S))
</em
>operations worst-case, where:
</span></div>
531 <div class=
"line"><a name=
"l00440"></a><span class=
"lineno"> 440</span> <span class=
"comment"> \remark * N is @c last - @c first,
</span></div>
532 <div class=
"line"><a name=
"l00441"></a><span class=
"lineno"> 441</span> <span class=
"comment"> \remark * K is the log of the range in bits (
32 for
32-bit integers using their full range),
</span></div>
533 <div class=
"line"><a name=
"l00442"></a><span class=
"lineno"> 442</span> <span class=
"comment"> \remark * S is a constant called max_splits, defaulting to
11 (except for strings where it is the log of the character size).
</span></div>
534 <div class=
"line"><a name=
"l00443"></a><span class=
"lineno"> 443</span> <span class=
"comment"></span></div>
535 <div class=
"line"><a name=
"l00444"></a><span class=
"lineno"> 444</span> <span class=
"comment">*/
</span></div>
536 <div class=
"line"><a name=
"l00445"></a><span class=
"lineno"> 445</span>  <span class=
"keyword">template
</span> <<span class=
"keyword">class
</span>RandomAccessIter,
<span class=
"keyword">class
</span>Get_char,
<span class=
"keyword">class
</span>Get_length,
</div>
537 <div class=
"line"><a name=
"l00446"></a><span class=
"lineno"> 446</span>  <span class=
"keyword">class
</span>Compare
></div>
538 <div class=
"line"><a name=
"l00447"></a><span class=
"lineno"><a class=
"line" href=
"namespaceboost_1_1sort.html#a7940f1b2a7746c083a12a4e26077096b"> 447</a></span>  <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> <a class=
"code" href=
"namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48">reverse_string_sort
</a>(RandomAccessIter first,
</div>
539 <div class=
"line"><a name=
"l00448"></a><span class=
"lineno"> 448</span>  RandomAccessIter last, Get_char getchar, Get_length length, Compare comp)
</div>
540 <div class=
"line"><a name=
"l00449"></a><span class=
"lineno"> 449</span>  {
</div>
541 <div class=
"line"><a name=
"l00450"></a><span class=
"lineno"> 450</span>  <span class=
"comment">//Don
't sort if it
's too small to optimize
</span></div>
542 <div class=
"line"><a name=
"l00451"></a><span class=
"lineno"> 451</span>  <span class=
"keywordflow">if
</span> (last - first
< detail::min_sort_size)
</div>
543 <div class=
"line"><a name=
"l00452"></a><span class=
"lineno"> 452</span>  std::sort(first, last, comp);
</div>
544 <div class=
"line"><a name=
"l00453"></a><span class=
"lineno"> 453</span>  <span class=
"keywordflow">else
</span> {
</div>
545 <div class=
"line"><a name=
"l00454"></a><span class=
"lineno"> 454</span>  <span class=
"comment">//skipping past empties, which allows us to get the character type
</span></div>
546 <div class=
"line"><a name=
"l00455"></a><span class=
"lineno"> 455</span>  <span class=
"comment">//.empty() is not used so as not to require a user declaration of it
</span></div>
547 <div class=
"line"><a name=
"l00456"></a><span class=
"lineno"> 456</span>  <span class=
"keywordflow">while
</span> (!length(*(--last))) {
</div>
548 <div class=
"line"><a name=
"l00457"></a><span class=
"lineno"> 457</span>  <span class=
"comment">//If there is just one non-empty at the beginning, this is sorted
</span></div>
549 <div class=
"line"><a name=
"l00458"></a><span class=
"lineno"> 458</span>  <span class=
"keywordflow">if
</span> (first == last)
</div>
550 <div class=
"line"><a name=
"l00459"></a><span class=
"lineno"> 459</span>  <span class=
"keywordflow">return
</span>;
</div>
551 <div class=
"line"><a name=
"l00460"></a><span class=
"lineno"> 460</span>  }
</div>
552 <div class=
"line"><a name=
"l00461"></a><span class=
"lineno"> 461</span>  <span class=
"comment">//making last just after the end of the non-empty part of the array
</span></div>
553 <div class=
"line"><a name=
"l00462"></a><span class=
"lineno"> 462</span>  <a class=
"code" href=
"namespaceboost_1_1sort.html#a7940f1b2a7746c083a12a4e26077096b">detail::reverse_string_sort
</a>(first, last +
1, getchar, length, comp,
</div>
554 <div class=
"line"><a name=
"l00463"></a><span class=
"lineno"> 463</span>  getchar((*last),
0));
</div>
555 <div class=
"line"><a name=
"l00464"></a><span class=
"lineno"> 464</span>  }
</div>
556 <div class=
"line"><a name=
"l00465"></a><span class=
"lineno"> 465</span>  }
</div>
557 <div class=
"line"><a name=
"l00466"></a><span class=
"lineno"> 466</span> }
</div>
558 <div class=
"line"><a name=
"l00467"></a><span class=
"lineno"> 467</span> }
</div>
559 <div class=
"line"><a name=
"l00468"></a><span class=
"lineno"> 468</span> </div>
560 <div class=
"line"><a name=
"l00469"></a><span class=
"lineno"> 469</span> <span class=
"preprocessor">#endif
</span></div>
561 <div class=
"ttc" id=
"namespaceboost_html"><div class=
"ttname"><a href=
"namespaceboost.html">boost
</a></div><div class=
"ttdef"><b>Definition:
</b> float_sort.hpp:
27</div></div>
562 <div class=
"ttc" id=
"namespaceboost_1_1sort_html_a82c4c0d7ba9873ecce7c674631dceae2"><div class=
"ttname"><a href=
"namespaceboost_1_1sort.html#a82c4c0d7ba9873ecce7c674631dceae2">boost::sort::string_sort
</a></div><div class=
"ttdeci">void string_sort(RandomAccessIter first, RandomAccessIter last, Get_char getchar, Get_length length, Compare comp)
</div><div class=
"ttdoc">String sort algorithm using random access iterators, wraps using default of unsigned char...
</div><div class=
"ttdef"><b>Definition:
</b> string_sort.hpp:
374</div></div>
563 <div class=
"ttc" id=
"namespaceboost_1_1sort_html_a950a2dbbe75f048a0b343dbf7c532dc0"><div class=
"ttname"><a href=
"namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">boost::sort::string_sort
</a></div><div class=
"ttdeci">void string_sort(RandomAccessIter first, RandomAccessIter last, Unsigned_char_type unused)
</div><div class=
"ttdoc">String sort algorithm using random access iterators, allowing character-type overloads. (All variants fall back to std::sort if the data size is too small, < detail::min_sort_size).
</div><div class=
"ttdef"><b>Definition:
</b> string_sort.hpp:
73</div></div>
564 <div class=
"ttc" id=
"namespaceboost_1_1sort_html_a4ad4785d90f47d51ff1d2fac8c21bb48"><div class=
"ttname"><a href=
"namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48">boost::sort::reverse_string_sort
</a></div><div class=
"ttdeci">void reverse_string_sort(RandomAccessIter first, RandomAccessIter last, Compare comp, Unsigned_char_type unused)
</div><div class=
"ttdoc">String sort algorithm using random access iterators, allowing character-type overloads.
</div><div class=
"ttdef"><b>Definition:
</b> string_sort.hpp:
183</div></div>
565 <div class=
"ttc" id=
"namespaceboost_1_1sort_html_a7940f1b2a7746c083a12a4e26077096b"><div class=
"ttname"><a href=
"namespaceboost_1_1sort.html#a7940f1b2a7746c083a12a4e26077096b">boost::sort::reverse_string_sort
</a></div><div class=
"ttdeci">void reverse_string_sort(RandomAccessIter first, RandomAccessIter last, Get_char getchar, Get_length length, Compare comp)
</div><div class=
"ttdoc">Reverse String sort algorithm using random access iterators.
</div><div class=
"ttdef"><b>Definition:
</b> string_sort.hpp:
447</div></div>
566 </div><!-- fragment --></div><!-- contents -->
567 <!-- start footer part -->
568 <hr class=
"footer"/><address class=
"footer"><small>
569 Generated on Fri Jan
9 2015 14:
20:
24 for Boost.Sort by
 <a href=
"http://www.doxygen.org/index.html">
570 <img class=
"footer" src=
"doxygen.png" alt=
"doxygen"/>
projects / ceph.git / blob