namespaceboost_1_1sort.html 90 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534
  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">
  3. <head>
  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: boost::sort Namespace Reference</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(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td style="padding-left: 0.5em;">
  26. <div id="projectname">Boost.Sort
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  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');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
  42. <li><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  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>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
  65. <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  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)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div id="nav-path" class="navpath">
  81. <ul>
  82. <li class="navelem"><a class="el" href="namespaceboost.html">boost</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1sort.html">sort</a></li> </ul>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#func-members">Functions</a> </div>
  88. <div class="headertitle">
  89. <div class="title">boost::sort Namespace Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  94. Functions</h2></td></tr>
  95. <tr class="memitem:ac3a946e197df6cfc4968c6371ace319b"><td class="memTemplParams" colspan="2">template&lt;class Data_type , class Cast_type &gt; </td></tr>
  96. <tr class="memitem:ac3a946e197df6cfc4968c6371ace319b"><td class="memTemplItemLeft" align="right" valign="top">Cast_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#ac3a946e197df6cfc4968c6371ace319b">float_mem_cast</a> (const Data_type &amp;data)</td></tr>
  97. <tr class="memdesc:ac3a946e197df6cfc4968c6371ace319b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Casts a float to the specified integer type. <a href="#ac3a946e197df6cfc4968c6371ace319b">More...</a><br /></td></tr>
  98. <tr class="separator:ac3a946e197df6cfc4968c6371ace319b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:acbcfc139de18c5c35c0ff1744c56e211"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter &gt; </td></tr>
  100. <tr class="memitem:acbcfc139de18c5c35c0ff1744c56e211"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#acbcfc139de18c5c35c0ff1744c56e211">float_sort</a> (RandomAccessIter first, RandomAccessIter last)</td></tr>
  101. <tr class="memdesc:acbcfc139de18c5c35c0ff1744c56e211"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>float_sort</code> with casting to the appropriate size. <a href="#acbcfc139de18c5c35c0ff1744c56e211">More...</a><br /></td></tr>
  102. <tr class="separator:acbcfc139de18c5c35c0ff1744c56e211"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ad65f9ec25686acfbd2a59683cc99be12"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Right_shift &gt; </td></tr>
  104. <tr class="memitem:ad65f9ec25686acfbd2a59683cc99be12"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#ad65f9ec25686acfbd2a59683cc99be12">float_sort</a> (RandomAccessIter first, RandomAccessIter last, Right_shift rshift)</td></tr>
  105. <tr class="memdesc:ad65f9ec25686acfbd2a59683cc99be12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point sort algorithm using random access iterators with just right-shift functor. <a href="#ad65f9ec25686acfbd2a59683cc99be12">More...</a><br /></td></tr>
  106. <tr class="separator:ad65f9ec25686acfbd2a59683cc99be12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a941746cb1461c5f4971c2cf1efb9301e"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Right_shift , class Compare &gt; </td></tr>
  108. <tr class="memitem:a941746cb1461c5f4971c2cf1efb9301e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a941746cb1461c5f4971c2cf1efb9301e">float_sort</a> (RandomAccessIter first, RandomAccessIter last, Right_shift rshift, Compare comp)</td></tr>
  109. <tr class="memdesc:a941746cb1461c5f4971c2cf1efb9301e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Float sort algorithm using random access iterators with both right-shift and user-defined comparison operator. <a href="#a941746cb1461c5f4971c2cf1efb9301e">More...</a><br /></td></tr>
  110. <tr class="separator:a941746cb1461c5f4971c2cf1efb9301e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ae6ffbcf932699589fd2b93879f209013"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter &gt; </td></tr>
  112. <tr class="memitem:ae6ffbcf932699589fd2b93879f209013"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#ae6ffbcf932699589fd2b93879f209013">integer_sort</a> (RandomAccessIter first, RandomAccessIter last)</td></tr>
  113. <tr class="memdesc:ae6ffbcf932699589fd2b93879f209013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer sort algorithm using random access iterators. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). <a href="#ae6ffbcf932699589fd2b93879f209013">More...</a><br /></td></tr>
  114. <tr class="separator:ae6ffbcf932699589fd2b93879f209013"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:aa4ebb2541be58f9f0fecd8d7c108b817"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Right_shift , class Compare &gt; </td></tr>
  116. <tr class="memitem:aa4ebb2541be58f9f0fecd8d7c108b817"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#aa4ebb2541be58f9f0fecd8d7c108b817">integer_sort</a> (RandomAccessIter first, RandomAccessIter last, Right_shift shift, Compare comp)</td></tr>
  117. <tr class="memdesc:aa4ebb2541be58f9f0fecd8d7c108b817"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer sort algorithm using random access iterators with both right-shift and user-defined comparison operator. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). <a href="#aa4ebb2541be58f9f0fecd8d7c108b817">More...</a><br /></td></tr>
  118. <tr class="separator:aa4ebb2541be58f9f0fecd8d7c108b817"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ae50349854aad811f67a540d9b3aa4d4a"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Right_shift &gt; </td></tr>
  120. <tr class="memitem:ae50349854aad811f67a540d9b3aa4d4a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#ae50349854aad811f67a540d9b3aa4d4a">integer_sort</a> (RandomAccessIter first, RandomAccessIter last, Right_shift shift)</td></tr>
  121. <tr class="memdesc:ae50349854aad811f67a540d9b3aa4d4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer sort algorithm using random access iterators with just right-shift functor. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). <a href="#ae50349854aad811f67a540d9b3aa4d4a">More...</a><br /></td></tr>
  122. <tr class="separator:ae50349854aad811f67a540d9b3aa4d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a4bc25fdacd4c948f631f08a3f9aa38eb"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter &gt; </td></tr>
  124. <tr class="memitem:a4bc25fdacd4c948f631f08a3f9aa38eb"><td class="memTemplItemLeft" align="right" valign="top">boost::enable_if_c&lt; std::numeric_limits&lt; typename std::iterator_traits&lt; RandomAccessIter &gt;::value_type &gt;::is_integer, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a4bc25fdacd4c948f631f08a3f9aa38eb">spreadsort</a> (RandomAccessIter first, RandomAccessIter last)</td></tr>
  125. <tr class="memdesc:a4bc25fdacd4c948f631f08a3f9aa38eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic <code>spreadsort</code> variant detecting integer-type elements so call to <code>integer_sort</code>. <a href="#a4bc25fdacd4c948f631f08a3f9aa38eb">More...</a><br /></td></tr>
  126. <tr class="separator:a4bc25fdacd4c948f631f08a3f9aa38eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a94a736da091bd5d3b525818399f1b272"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter &gt; </td></tr>
  128. <tr class="memitem:a94a736da091bd5d3b525818399f1b272"><td class="memTemplItemLeft" align="right" valign="top">boost::enable_if_c&lt; !std::numeric_limits&lt; typename std::iterator_traits&lt; RandomAccessIter &gt;::value_type &gt;::is_integer &amp;&amp;std::numeric_limits&lt; typename std::iterator_traits&lt; RandomAccessIter &gt;::value_type &gt;::is_iec559, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a94a736da091bd5d3b525818399f1b272">spreadsort</a> (RandomAccessIter first, RandomAccessIter last)</td></tr>
  129. <tr class="memdesc:a94a736da091bd5d3b525818399f1b272"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic <code>spreadsort</code> variant detecting float element type so call to <code>float_sort</code>. <a href="#a94a736da091bd5d3b525818399f1b272">More...</a><br /></td></tr>
  130. <tr class="separator:a94a736da091bd5d3b525818399f1b272"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:aafdea66d9b4a7faef5604b3079b525fa"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter &gt; </td></tr>
  132. <tr class="memitem:aafdea66d9b4a7faef5604b3079b525fa"><td class="memTemplItemLeft" align="right" valign="top">boost::enable_if_c&lt; is_same&lt; typename std::iterator_traits&lt; RandomAccessIter &gt;::value_type, typename std::string &gt;::value||is_same&lt; typename std::iterator_traits&lt; RandomAccessIter &gt;::value_type, typename std::wstring &gt;::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#aafdea66d9b4a7faef5604b3079b525fa">spreadsort</a> (RandomAccessIter first, RandomAccessIter last)</td></tr>
  133. <tr class="memdesc:aafdea66d9b4a7faef5604b3079b525fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic <code>spreadsort</code> variant detecting string element type so call to <code>string_sort</code> for <code>std::strings</code> and <code>std::wstrings</code>. <a href="#aafdea66d9b4a7faef5604b3079b525fa">More...</a><br /></td></tr>
  134. <tr class="separator:aafdea66d9b4a7faef5604b3079b525fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a950a2dbbe75f048a0b343dbf7c532dc0"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Unsigned_char_type &gt; </td></tr>
  136. <tr class="memitem:a950a2dbbe75f048a0b343dbf7c532dc0"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a950a2dbbe75f048a0b343dbf7c532dc0">string_sort</a> (RandomAccessIter first, RandomAccessIter last, Unsigned_char_type unused)</td></tr>
  137. <tr class="memdesc:a950a2dbbe75f048a0b343dbf7c532dc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">String sort algorithm using random access iterators, allowing character-type overloads.<br />
  138. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). <a href="#a950a2dbbe75f048a0b343dbf7c532dc0">More...</a><br /></td></tr>
  139. <tr class="separator:a950a2dbbe75f048a0b343dbf7c532dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a6acd5fc94521b0a5cb47dc491b6d862f"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter &gt; </td></tr>
  141. <tr class="memitem:a6acd5fc94521b0a5cb47dc491b6d862f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a6acd5fc94521b0a5cb47dc491b6d862f">string_sort</a> (RandomAccessIter first, RandomAccessIter last)</td></tr>
  142. <tr class="memdesc:a6acd5fc94521b0a5cb47dc491b6d862f"><td class="mdescLeft">&#160;</td><td class="mdescRight">String sort algorithm using random access iterators, wraps using default of unsigned char. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). <a href="#a6acd5fc94521b0a5cb47dc491b6d862f">More...</a><br /></td></tr>
  143. <tr class="separator:a6acd5fc94521b0a5cb47dc491b6d862f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a4ad4785d90f47d51ff1d2fac8c21bb48"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Compare , class Unsigned_char_type &gt; </td></tr>
  145. <tr class="memitem:a4ad4785d90f47d51ff1d2fac8c21bb48"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a4ad4785d90f47d51ff1d2fac8c21bb48">reverse_string_sort</a> (RandomAccessIter first, RandomAccessIter last, Compare comp, Unsigned_char_type unused)</td></tr>
  146. <tr class="memdesc:a4ad4785d90f47d51ff1d2fac8c21bb48"><td class="mdescLeft">&#160;</td><td class="mdescRight">String sort algorithm using random access iterators, allowing character-type overloads. <a href="#a4ad4785d90f47d51ff1d2fac8c21bb48">More...</a><br /></td></tr>
  147. <tr class="separator:a4ad4785d90f47d51ff1d2fac8c21bb48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:afd4938835fd03aab9c42bd0653e5dbe5"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Compare &gt; </td></tr>
  149. <tr class="memitem:afd4938835fd03aab9c42bd0653e5dbe5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#afd4938835fd03aab9c42bd0653e5dbe5">reverse_string_sort</a> (RandomAccessIter first, RandomAccessIter last, Compare comp)</td></tr>
  150. <tr class="memdesc:afd4938835fd03aab9c42bd0653e5dbe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">String sort algorithm using random access iterators, wraps using default of <code>unsigned</code> char. <a href="#afd4938835fd03aab9c42bd0653e5dbe5">More...</a><br /></td></tr>
  151. <tr class="separator:afd4938835fd03aab9c42bd0653e5dbe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a5143ec4f58cfe13eca2a0d6b6f6a6680"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Get_char , class Get_length &gt; </td></tr>
  153. <tr class="memitem:a5143ec4f58cfe13eca2a0d6b6f6a6680"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a5143ec4f58cfe13eca2a0d6b6f6a6680">string_sort</a> (RandomAccessIter first, RandomAccessIter last, Get_char get_character, Get_length length)</td></tr>
  154. <tr class="memdesc:a5143ec4f58cfe13eca2a0d6b6f6a6680"><td class="mdescLeft">&#160;</td><td class="mdescRight">String sort algorithm using random access iterators, wraps using default of <code>unsigned</code> char. <a href="#a5143ec4f58cfe13eca2a0d6b6f6a6680">More...</a><br /></td></tr>
  155. <tr class="separator:a5143ec4f58cfe13eca2a0d6b6f6a6680"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a82c4c0d7ba9873ecce7c674631dceae2"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Get_char , class Get_length , class Compare &gt; </td></tr>
  157. <tr class="memitem:a82c4c0d7ba9873ecce7c674631dceae2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a82c4c0d7ba9873ecce7c674631dceae2">string_sort</a> (RandomAccessIter first, RandomAccessIter last, Get_char get_character, Get_length length, Compare comp)</td></tr>
  158. <tr class="memdesc:a82c4c0d7ba9873ecce7c674631dceae2"><td class="mdescLeft">&#160;</td><td class="mdescRight">String sort algorithm using random access iterators, wraps using default of <code>unsigned</code> char. <a href="#a82c4c0d7ba9873ecce7c674631dceae2">More...</a><br /></td></tr>
  159. <tr class="separator:a82c4c0d7ba9873ecce7c674631dceae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a7940f1b2a7746c083a12a4e26077096b"><td class="memTemplParams" colspan="2">template&lt;class RandomAccessIter , class Get_char , class Get_length , class Compare &gt; </td></tr>
  161. <tr class="memitem:a7940f1b2a7746c083a12a4e26077096b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1sort.html#a7940f1b2a7746c083a12a4e26077096b">reverse_string_sort</a> (RandomAccessIter first, RandomAccessIter last, Get_char get_character, Get_length length, Compare comp)</td></tr>
  162. <tr class="memdesc:a7940f1b2a7746c083a12a4e26077096b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse String sort algorithm using random access iterators. <a href="#a7940f1b2a7746c083a12a4e26077096b">More...</a><br /></td></tr>
  163. <tr class="separator:a7940f1b2a7746c083a12a4e26077096b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. </table>
  165. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  166. <div class="textblock"><p>Namespace for spreadsort sort variants for different data types. </p><dl class="section note"><dt>Note</dt><dd>Use hyperlinks (coloured) to get detailed information about functions. </dd></dl>
  167. </div><h2 class="groupheader">Function Documentation</h2>
  168. <a class="anchor" id="ac3a946e197df6cfc4968c6371ace319b"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <div class="memtemplate">
  172. template&lt;class Data_type , class Cast_type &gt; </div>
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">Cast_type boost::sort::float_mem_cast </td>
  179. <td>(</td>
  180. <td class="paramtype">const Data_type &amp;&#160;</td>
  181. <td class="paramname"><em>data</em></td><td>)</td>
  182. <td></td>
  183. </tr>
  184. </table>
  185. </td>
  186. <td class="mlabels-right">
  187. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Casts a float to the specified integer type. </p>
  192. <dl class="tparams"><dt>Template Parameters</dt><dd>
  193. <table class="tparams">
  194. <tr><td class="paramname">Data_type</td><td>Floating-point IEEE 754/IEC559 type. </td></tr>
  195. <tr><td class="paramname">Cast_type</td><td>Integer type (same size) to which to cast.</td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structrightshift.html">rightshift</a> {</div>
  200. <div class="line"> <span class="keywordtype">int</span> operator()(<span class="keyword">const</span> <a class="code" href="struct_d_a_t_a___t_y_p_e.html">DATA_TYPE</a> &amp;x, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> offset)<span class="keyword"> const </span>{</div>
  201. <div class="line"> <span class="keywordflow">return</span> <a class="code" href="namespaceboost_1_1sort.html#ac3a946e197df6cfc4968c6371ace319b">float_mem_cast</a>&lt;<a class="code" href="floatfunctorsample_8cpp.html#ae35c40bc2f912c11f0e36ac66cba4489">KEY_TYPE</a>, <a class="code" href="double_8cpp.html#a38779bfd63dd113c9f7602664546a58c">CAST_TYPE</a>&gt;(x.<a class="code" href="struct_d_a_t_a___t_y_p_e.html#aa28561fc8e223d84187ccfaf99953bae">key</a>) &gt;&gt; offset;</div>
  202. <div class="line"> }</div>
  203. <div class="line">};</div>
  204. </div><!-- fragment --> </dd></dl>
  205. </div>
  206. </div>
  207. <a class="anchor" id="acbcfc139de18c5c35c0ff1744c56e211"></a>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <div class="memtemplate">
  211. template&lt;class RandomAccessIter &gt; </div>
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">void boost::sort::float_sort </td>
  218. <td>(</td>
  219. <td class="paramtype">RandomAccessIter&#160;</td>
  220. <td class="paramname"><em>first</em>, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype">RandomAccessIter&#160;</td>
  226. <td class="paramname"><em>last</em>&#160;</td>
  227. </tr>
  228. <tr>
  229. <td></td>
  230. <td>)</td>
  231. <td></td><td></td>
  232. </tr>
  233. </table>
  234. </td>
  235. <td class="mlabels-right">
  236. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p><code>float_sort</code> with casting to the appropriate size. </p>
  241. <dl class="tparams"><dt>Template Parameters</dt><dd>
  242. <table class="tparams">
  243. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a></td></tr>
  244. </table>
  245. </dd>
  246. </dl>
  247. <dl class="params"><dt>Parameters</dt><dd>
  248. <table class="params">
  249. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  250. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data.</td></tr>
  251. </table>
  252. </dd>
  253. </dl>
  254. <p>Some performance plots of runtime vs. n and log(range) are provided:<br />
  255. <a href="../../doc/graph/windows_float_sort.htm">windows_float_sort</a> <br />
  256. <a href="../../doc/graph/osx_float_sort.htm">osx_float_sort</a></p>
  257. <dl class="section user"><dt>A simple example of sorting some floating-point is:</dt><dd><div class="fragment"><div class="line">vector&lt;float&gt; vec;</div>
  258. <div class="line">vec.push_back(1.0);</div>
  259. <div class="line">vec.push_back(2.3);</div>
  260. <div class="line">vec.push_back(1.3);</div>
  261. <div class="line"><a class="code" href="namespaceboost_1_1sort.html#a4bc25fdacd4c948f631f08a3f9aa38eb">spreadsort</a>(vec.begin(), vec.end());</div>
  262. </div><!-- fragment --> </dd></dl>
  263. <dl class="section user"><dt>The sorted vector contains ascending values "1.0 1.3 2.3".</dt><dd></dd></dl>
  264. </div>
  265. </div>
  266. <a class="anchor" id="ad65f9ec25686acfbd2a59683cc99be12"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <div class="memtemplate">
  270. template&lt;class RandomAccessIter , class Right_shift &gt; </div>
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void boost::sort::float_sort </td>
  277. <td>(</td>
  278. <td class="paramtype">RandomAccessIter&#160;</td>
  279. <td class="paramname"><em>first</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">RandomAccessIter&#160;</td>
  285. <td class="paramname"><em>last</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">Right_shift&#160;</td>
  291. <td class="paramname"><em>rshift</em>&#160;</td>
  292. </tr>
  293. <tr>
  294. <td></td>
  295. <td>)</td>
  296. <td></td><td></td>
  297. </tr>
  298. </table>
  299. </td>
  300. <td class="mlabels-right">
  301. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Floating-point sort algorithm using random access iterators with just right-shift functor. </p>
  306. <dl class="tparams"><dt>Template Parameters</dt><dd>
  307. <table class="tparams">
  308. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  309. <tr><td class="paramname">Right_shift</td><td>Functor for right-shift by parameter <code>shift</code> bits.</td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <dl class="params"><dt>Parameters</dt><dd>
  314. <table class="params">
  315. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  316. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  317. <tr><td class="paramdir">[in]</td><td class="paramname">rshift</td><td>Number of bits to right-shift (using functor). </td></tr>
  318. </table>
  319. </dd>
  320. </dl>
  321. </div>
  322. </div>
  323. <a class="anchor" id="a941746cb1461c5f4971c2cf1efb9301e"></a>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <div class="memtemplate">
  327. template&lt;class RandomAccessIter , class Right_shift , class Compare &gt; </div>
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">void boost::sort::float_sort </td>
  334. <td>(</td>
  335. <td class="paramtype">RandomAccessIter&#160;</td>
  336. <td class="paramname"><em>first</em>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">RandomAccessIter&#160;</td>
  342. <td class="paramname"><em>last</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype">Right_shift&#160;</td>
  348. <td class="paramname"><em>rshift</em>, </td>
  349. </tr>
  350. <tr>
  351. <td class="paramkey"></td>
  352. <td></td>
  353. <td class="paramtype">Compare&#160;</td>
  354. <td class="paramname"><em>comp</em>&#160;</td>
  355. </tr>
  356. <tr>
  357. <td></td>
  358. <td>)</td>
  359. <td></td><td></td>
  360. </tr>
  361. </table>
  362. </td>
  363. <td class="mlabels-right">
  364. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. <p>Float sort algorithm using random access iterators with both right-shift and user-defined comparison operator. </p>
  369. <dl class="tparams"><dt>Template Parameters</dt><dd>
  370. <table class="tparams">
  371. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  372. <tr><td class="paramname">Right_shift</td><td>functor for right-shift by parameter <code>shift</code> bits. </td></tr>
  373. <tr><td class="paramname">Comp</td><td>To provide <code>operator&lt;</code> for user-defined comparison.</td></tr>
  374. </table>
  375. </dd>
  376. </dl>
  377. <dl class="params"><dt>Parameters</dt><dd>
  378. <table class="params">
  379. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  380. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  381. <tr><td class="paramdir">[in]</td><td class="paramname">rshift</td><td>Number of bits to right-shift (using functor). </td></tr>
  382. <tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>comparison functor. </td></tr>
  383. </table>
  384. </dd>
  385. </dl>
  386. </div>
  387. </div>
  388. <a class="anchor" id="ae6ffbcf932699589fd2b93879f209013"></a>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <div class="memtemplate">
  392. template&lt;class RandomAccessIter &gt; </div>
  393. <table class="mlabels">
  394. <tr>
  395. <td class="mlabels-left">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">void boost::sort::integer_sort </td>
  399. <td>(</td>
  400. <td class="paramtype">RandomAccessIter&#160;</td>
  401. <td class="paramname"><em>first</em>, </td>
  402. </tr>
  403. <tr>
  404. <td class="paramkey"></td>
  405. <td></td>
  406. <td class="paramtype">RandomAccessIter&#160;</td>
  407. <td class="paramname"><em>last</em>&#160;</td>
  408. </tr>
  409. <tr>
  410. <td></td>
  411. <td>)</td>
  412. <td></td><td></td>
  413. </tr>
  414. </table>
  415. </td>
  416. <td class="mlabels-right">
  417. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  418. </tr>
  419. </table>
  420. </div><div class="memdoc">
  421. <p>Integer sort algorithm using random access iterators. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). </p>
  422. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  423. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  424. <br />
  425. Some performance plots of runtime vs. n and log(range) are provided:<br />
  426. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  427. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  428. <dl class="tparams"><dt>Template Parameters</dt><dd>
  429. <table class="tparams">
  430. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  431. </table>
  432. </dd>
  433. </dl>
  434. <dl class="params"><dt>Parameters</dt><dd>
  435. <table class="params">
  436. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  437. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data.</td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  442. <dd>
  443. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  444. <dd>
  445. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  446. <dd>
  447. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  448. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  449. <dl class="exception"><dt>Exceptions</dt><dd>
  450. <table class="exception">
  451. <tr><td class="paramname">std::exception</td><td>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></tr>
  452. </table>
  453. </dd>
  454. </dl>
  455. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  456. <dd>
  457. Invalid arguments cause undefined behaviour. </dd></dl>
  458. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  459. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  460. <dd>
  461. * N is <code>last</code> - <code>first</code>, </dd>
  462. <dd>
  463. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  464. <dd>
  465. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  466. </div>
  467. </div>
  468. <a class="anchor" id="aa4ebb2541be58f9f0fecd8d7c108b817"></a>
  469. <div class="memitem">
  470. <div class="memproto">
  471. <div class="memtemplate">
  472. template&lt;class RandomAccessIter , class Right_shift , class Compare &gt; </div>
  473. <table class="mlabels">
  474. <tr>
  475. <td class="mlabels-left">
  476. <table class="memname">
  477. <tr>
  478. <td class="memname">void boost::sort::integer_sort </td>
  479. <td>(</td>
  480. <td class="paramtype">RandomAccessIter&#160;</td>
  481. <td class="paramname"><em>first</em>, </td>
  482. </tr>
  483. <tr>
  484. <td class="paramkey"></td>
  485. <td></td>
  486. <td class="paramtype">RandomAccessIter&#160;</td>
  487. <td class="paramname"><em>last</em>, </td>
  488. </tr>
  489. <tr>
  490. <td class="paramkey"></td>
  491. <td></td>
  492. <td class="paramtype">Right_shift&#160;</td>
  493. <td class="paramname"><em>shift</em>, </td>
  494. </tr>
  495. <tr>
  496. <td class="paramkey"></td>
  497. <td></td>
  498. <td class="paramtype">Compare&#160;</td>
  499. <td class="paramname"><em>comp</em>&#160;</td>
  500. </tr>
  501. <tr>
  502. <td></td>
  503. <td>)</td>
  504. <td></td><td></td>
  505. </tr>
  506. </table>
  507. </td>
  508. <td class="mlabels-right">
  509. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <p>Integer sort algorithm using random access iterators with both right-shift and user-defined comparison operator. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). </p>
  514. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  515. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  516. <br />
  517. Some performance plots of runtime vs. n and log(range) are provided:<br />
  518. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  519. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  520. <dl class="tparams"><dt>Template Parameters</dt><dd>
  521. <table class="tparams">
  522. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  523. <tr><td class="paramname">Right_shift</td><td>functor for right-shift by parameter <code>shift</code> bits. </td></tr>
  524. <tr><td class="paramname">Comp</td><td>To provide <code>operator&lt;</code> for user-defined comparison.</td></tr>
  525. </table>
  526. </dd>
  527. </dl>
  528. <dl class="params"><dt>Parameters</dt><dd>
  529. <table class="params">
  530. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  531. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  532. <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>Number of bits to right-shift (using functor). </td></tr>
  533. <tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>comparison functor.</td></tr>
  534. </table>
  535. </dd>
  536. </dl>
  537. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  538. <dd>
  539. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  540. <dd>
  541. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  542. <dd>
  543. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  544. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  545. <dl class="section return"><dt>Returns</dt><dd><code>void</code>.</dd></dl>
  546. <dl class="exception"><dt>Exceptions</dt><dd>
  547. <table class="exception">
  548. <tr><td class="paramname">std::exception</td><td>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></tr>
  549. </table>
  550. </dd>
  551. </dl>
  552. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  553. <dd>
  554. Invalid arguments cause undefined behaviour. </dd></dl>
  555. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  556. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  557. <dd>
  558. * N is <code>last</code> - <code>first</code>, </dd>
  559. <dd>
  560. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  561. <dd>
  562. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  563. </div>
  564. </div>
  565. <a class="anchor" id="ae50349854aad811f67a540d9b3aa4d4a"></a>
  566. <div class="memitem">
  567. <div class="memproto">
  568. <div class="memtemplate">
  569. template&lt;class RandomAccessIter , class Right_shift &gt; </div>
  570. <table class="mlabels">
  571. <tr>
  572. <td class="mlabels-left">
  573. <table class="memname">
  574. <tr>
  575. <td class="memname">void boost::sort::integer_sort </td>
  576. <td>(</td>
  577. <td class="paramtype">RandomAccessIter&#160;</td>
  578. <td class="paramname"><em>first</em>, </td>
  579. </tr>
  580. <tr>
  581. <td class="paramkey"></td>
  582. <td></td>
  583. <td class="paramtype">RandomAccessIter&#160;</td>
  584. <td class="paramname"><em>last</em>, </td>
  585. </tr>
  586. <tr>
  587. <td class="paramkey"></td>
  588. <td></td>
  589. <td class="paramtype">Right_shift&#160;</td>
  590. <td class="paramname"><em>shift</em>&#160;</td>
  591. </tr>
  592. <tr>
  593. <td></td>
  594. <td>)</td>
  595. <td></td><td></td>
  596. </tr>
  597. </table>
  598. </td>
  599. <td class="mlabels-right">
  600. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  601. </tr>
  602. </table>
  603. </div><div class="memdoc">
  604. <p>Integer sort algorithm using random access iterators with just right-shift functor. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). </p>
  605. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  606. </p><dl class="section user"><dt>Performance:</dt><dd>Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  607. <br />
  608. Some performance plots of runtime vs. n and log(range) are provided:<br />
  609. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a><br />
  610. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></dd></dl>
  611. <dl class="tparams"><dt>Template Parameters</dt><dd>
  612. <table class="tparams">
  613. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  614. <tr><td class="paramname">Right_shift</td><td>functor for right-shift by parameter <code>shift</code> bits.</td></tr>
  615. </table>
  616. </dd>
  617. </dl>
  618. <dl class="params"><dt>Parameters</dt><dd>
  619. <table class="params">
  620. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  621. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  622. <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>Number of bits to right-shift (using functor).</td></tr>
  623. </table>
  624. </dd>
  625. </dl>
  626. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  627. <dd>
  628. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  629. <dd>
  630. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  631. <dd>
  632. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  633. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  634. <dl class="exception"><dt>Exceptions</dt><dd>
  635. <table class="exception">
  636. <tr><td class="paramname">std::exception</td><td>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></tr>
  637. </table>
  638. </dd>
  639. </dl>
  640. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  641. <dd>
  642. Invalid arguments cause undefined behaviour. </dd></dl>
  643. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  644. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  645. <dd>
  646. * N is <code>last</code> - <code>first</code>, </dd>
  647. <dd>
  648. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  649. <dd>
  650. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  651. </div>
  652. </div>
  653. <a class="anchor" id="a4ad4785d90f47d51ff1d2fac8c21bb48"></a>
  654. <div class="memitem">
  655. <div class="memproto">
  656. <div class="memtemplate">
  657. template&lt;class RandomAccessIter , class Compare , class Unsigned_char_type &gt; </div>
  658. <table class="mlabels">
  659. <tr>
  660. <td class="mlabels-left">
  661. <table class="memname">
  662. <tr>
  663. <td class="memname">void boost::sort::reverse_string_sort </td>
  664. <td>(</td>
  665. <td class="paramtype">RandomAccessIter&#160;</td>
  666. <td class="paramname"><em>first</em>, </td>
  667. </tr>
  668. <tr>
  669. <td class="paramkey"></td>
  670. <td></td>
  671. <td class="paramtype">RandomAccessIter&#160;</td>
  672. <td class="paramname"><em>last</em>, </td>
  673. </tr>
  674. <tr>
  675. <td class="paramkey"></td>
  676. <td></td>
  677. <td class="paramtype">Compare&#160;</td>
  678. <td class="paramname"><em>comp</em>, </td>
  679. </tr>
  680. <tr>
  681. <td class="paramkey"></td>
  682. <td></td>
  683. <td class="paramtype">Unsigned_char_type&#160;</td>
  684. <td class="paramname"><em>unused</em>&#160;</td>
  685. </tr>
  686. <tr>
  687. <td></td>
  688. <td>)</td>
  689. <td></td><td></td>
  690. </tr>
  691. </table>
  692. </td>
  693. <td class="mlabels-right">
  694. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  695. </tr>
  696. </table>
  697. </div><div class="memdoc">
  698. <p>String sort algorithm using random access iterators, allowing character-type overloads. </p>
  699. <p>(All variants fall back to <code>std::sort</code> if the data size is too small, &lt; detail::min_sort_size).</p>
  700. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  701. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  702. <br />
  703. Some performance plots of runtime vs. n and log(range) are provided:<br />
  704. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  705. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  706. <dl class="tparams"><dt>Template Parameters</dt><dd>
  707. <table class="tparams">
  708. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  709. <tr><td class="paramname">Comp</td><td>To provide <code>operator&lt;</code> for user-defined comparison. </td></tr>
  710. <tr><td class="paramname">Unsigned_char_type</td><td>Unsigned character type used for string.</td></tr>
  711. </table>
  712. </dd>
  713. </dl>
  714. <dl class="params"><dt>Parameters</dt><dd>
  715. <table class="params">
  716. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  717. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  718. <tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>comparison functor. </td></tr>
  719. <tr><td class="paramdir">[in]</td><td class="paramname">unused</td><td>Unused ???</td></tr>
  720. </table>
  721. </dd>
  722. </dl>
  723. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  724. <dd>
  725. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  726. <dd>
  727. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  728. <dd>
  729. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  730. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  731. <dl class="section return"><dt>Returns</dt><dd><code>void</code>.</dd></dl>
  732. <dl class="exception"><dt>Exceptions</dt><dd>
  733. <table class="exception">
  734. <tr><td class="paramname">std::exception</td><td>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></tr>
  735. </table>
  736. </dd>
  737. </dl>
  738. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  739. <dd>
  740. Invalid arguments cause undefined behaviour. </dd></dl>
  741. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  742. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  743. <dd>
  744. * N is <code>last</code> - <code>first</code>, </dd>
  745. <dd>
  746. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  747. <dd>
  748. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  749. </div>
  750. </div>
  751. <a class="anchor" id="afd4938835fd03aab9c42bd0653e5dbe5"></a>
  752. <div class="memitem">
  753. <div class="memproto">
  754. <div class="memtemplate">
  755. template&lt;class RandomAccessIter , class Compare &gt; </div>
  756. <table class="mlabels">
  757. <tr>
  758. <td class="mlabels-left">
  759. <table class="memname">
  760. <tr>
  761. <td class="memname">void boost::sort::reverse_string_sort </td>
  762. <td>(</td>
  763. <td class="paramtype">RandomAccessIter&#160;</td>
  764. <td class="paramname"><em>first</em>, </td>
  765. </tr>
  766. <tr>
  767. <td class="paramkey"></td>
  768. <td></td>
  769. <td class="paramtype">RandomAccessIter&#160;</td>
  770. <td class="paramname"><em>last</em>, </td>
  771. </tr>
  772. <tr>
  773. <td class="paramkey"></td>
  774. <td></td>
  775. <td class="paramtype">Compare&#160;</td>
  776. <td class="paramname"><em>comp</em>&#160;</td>
  777. </tr>
  778. <tr>
  779. <td></td>
  780. <td>)</td>
  781. <td></td><td></td>
  782. </tr>
  783. </table>
  784. </td>
  785. <td class="mlabels-right">
  786. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  787. </tr>
  788. </table>
  789. </div><div class="memdoc">
  790. <p>String sort algorithm using random access iterators, wraps using default of <code>unsigned</code> char. </p>
  791. <p>(All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>).</p>
  792. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  793. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  794. <br />
  795. Some performance plots of runtime vs. n and log(range) are provided:<br />
  796. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  797. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  798. <dl class="tparams"><dt>Template Parameters</dt><dd>
  799. <table class="tparams">
  800. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  801. <tr><td class="paramname">Comp</td><td>To provide <code>operator&lt;</code> for user-defined comparison.</td></tr>
  802. </table>
  803. </dd>
  804. </dl>
  805. <dl class="params"><dt>Parameters</dt><dd>
  806. <table class="params">
  807. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  808. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  809. <tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>Comparison functor.</td></tr>
  810. </table>
  811. </dd>
  812. </dl>
  813. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  814. <dd>
  815. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  816. <dd>
  817. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  818. <dd>
  819. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  820. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  821. <dl class="section return"><dt>Returns</dt><dd><code>void</code>.</dd></dl>
  822. <dl class="exception"><dt>Exceptions</dt><dd>
  823. <table class="exception">
  824. <tr><td class="paramname">std::exception</td><td>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></tr>
  825. </table>
  826. </dd>
  827. </dl>
  828. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  829. <dd>
  830. Invalid arguments cause undefined behaviour. </dd></dl>
  831. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  832. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  833. <dd>
  834. * N is <code>last</code> - <code>first</code>, </dd>
  835. <dd>
  836. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  837. <dd>
  838. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  839. </div>
  840. </div>
  841. <a class="anchor" id="a7940f1b2a7746c083a12a4e26077096b"></a>
  842. <div class="memitem">
  843. <div class="memproto">
  844. <div class="memtemplate">
  845. template&lt;class RandomAccessIter , class Get_char , class Get_length , class Compare &gt; </div>
  846. <table class="mlabels">
  847. <tr>
  848. <td class="mlabels-left">
  849. <table class="memname">
  850. <tr>
  851. <td class="memname">void boost::sort::reverse_string_sort </td>
  852. <td>(</td>
  853. <td class="paramtype">RandomAccessIter&#160;</td>
  854. <td class="paramname"><em>first</em>, </td>
  855. </tr>
  856. <tr>
  857. <td class="paramkey"></td>
  858. <td></td>
  859. <td class="paramtype">RandomAccessIter&#160;</td>
  860. <td class="paramname"><em>last</em>, </td>
  861. </tr>
  862. <tr>
  863. <td class="paramkey"></td>
  864. <td></td>
  865. <td class="paramtype">Get_char&#160;</td>
  866. <td class="paramname"><em>get_character</em>, </td>
  867. </tr>
  868. <tr>
  869. <td class="paramkey"></td>
  870. <td></td>
  871. <td class="paramtype">Get_length&#160;</td>
  872. <td class="paramname"><em>length</em>, </td>
  873. </tr>
  874. <tr>
  875. <td class="paramkey"></td>
  876. <td></td>
  877. <td class="paramtype">Compare&#160;</td>
  878. <td class="paramname"><em>comp</em>&#160;</td>
  879. </tr>
  880. <tr>
  881. <td></td>
  882. <td>)</td>
  883. <td></td><td></td>
  884. </tr>
  885. </table>
  886. </td>
  887. <td class="mlabels-right">
  888. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  889. </tr>
  890. </table>
  891. </div><div class="memdoc">
  892. <p>Reverse String sort algorithm using random access iterators. </p>
  893. <p>(All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>).</p>
  894. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  895. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  896. <br />
  897. Some performance plots of runtime vs. n and log(range) are provided:<br />
  898. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  899. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  900. <dl class="tparams"><dt>Template Parameters</dt><dd>
  901. <table class="tparams">
  902. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  903. <tr><td class="paramname">Get_char</td><td>???. </td></tr>
  904. <tr><td class="paramname">Get_length</td><td>??? TODO </td></tr>
  905. <tr><td class="paramname">Comp</td><td>To provide <code>operator&lt;</code> for user-defined comparison.</td></tr>
  906. </table>
  907. </dd>
  908. </dl>
  909. <dl class="params"><dt>Parameters</dt><dd>
  910. <table class="params">
  911. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  912. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  913. <tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>comparison functor. </td></tr>
  914. <tr><td class="paramdir">[in]</td><td class="paramname">get_character</td><td>??? </td></tr>
  915. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>???</td></tr>
  916. </table>
  917. </dd>
  918. </dl>
  919. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  920. <dd>
  921. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  922. <dd>
  923. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd></dl>
  924. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  925. <dl class="section return"><dt>Returns</dt><dd><code>void</code>.</dd></dl>
  926. <dl class="exception"><dt>Exceptions</dt><dd>
  927. <table class="exception">
  928. <tr><td class="paramname">std::exception</td><td>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></tr>
  929. </table>
  930. </dd>
  931. </dl>
  932. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  933. <dd>
  934. Invalid arguments cause undefined behaviour. </dd></dl>
  935. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  936. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  937. <dd>
  938. * N is <code>last</code> - <code>first</code>, </dd>
  939. <dd>
  940. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  941. <dd>
  942. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  943. </div>
  944. </div>
  945. <a class="anchor" id="a4bc25fdacd4c948f631f08a3f9aa38eb"></a>
  946. <div class="memitem">
  947. <div class="memproto">
  948. <div class="memtemplate">
  949. template&lt;class RandomAccessIter &gt; </div>
  950. <table class="mlabels">
  951. <tr>
  952. <td class="mlabels-left">
  953. <table class="memname">
  954. <tr>
  955. <td class="memname">boost::enable_if_c&lt; std::numeric_limits&lt; typename std::iterator_traits&lt;RandomAccessIter&gt;::value_type &gt;::is_integer, void &gt;::type boost::sort::spreadsort </td>
  956. <td>(</td>
  957. <td class="paramtype">RandomAccessIter&#160;</td>
  958. <td class="paramname"><em>first</em>, </td>
  959. </tr>
  960. <tr>
  961. <td class="paramkey"></td>
  962. <td></td>
  963. <td class="paramtype">RandomAccessIter&#160;</td>
  964. <td class="paramname"><em>last</em>&#160;</td>
  965. </tr>
  966. <tr>
  967. <td></td>
  968. <td>)</td>
  969. <td></td><td></td>
  970. </tr>
  971. </table>
  972. </td>
  973. <td class="mlabels-right">
  974. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  975. </tr>
  976. </table>
  977. </div><div class="memdoc">
  978. <p>Generic <code>spreadsort</code> variant detecting integer-type elements so call to <code>integer_sort</code>. </p>
  979. <p>If the data type provided is an integer, <code>integer_sort</code> is used. </p><dl class="section note"><dt>Note</dt><dd>Sorting other data types requires picking between <code>integer_sort</code>, <code>float_sort</code> and <code>string_sort</code> directly, as <code>spreadsort</code> won't accept types that don't have the appropriate <code>type_traits</code>. </dd></dl>
  980. <dl class="tparams"><dt>Template Parameters</dt><dd>
  981. <table class="tparams">
  982. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  983. </table>
  984. </dd>
  985. </dl>
  986. <dl class="params"><dt>Parameters</dt><dd>
  987. <table class="params">
  988. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  989. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data.</td></tr>
  990. </table>
  991. </dd>
  992. </dl>
  993. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  994. <dd>
  995. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  996. <dd>
  997. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  998. <dd>
  999. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  1000. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order. </dd></dl>
  1001. </div>
  1002. </div>
  1003. <a class="anchor" id="a94a736da091bd5d3b525818399f1b272"></a>
  1004. <div class="memitem">
  1005. <div class="memproto">
  1006. <div class="memtemplate">
  1007. template&lt;class RandomAccessIter &gt; </div>
  1008. <table class="mlabels">
  1009. <tr>
  1010. <td class="mlabels-left">
  1011. <table class="memname">
  1012. <tr>
  1013. <td class="memname">boost::enable_if_c&lt; !std::numeric_limits&lt; typename std::iterator_traits&lt;RandomAccessIter&gt;::value_type &gt;::is_integer &amp;&amp; std::numeric_limits&lt; typename std::iterator_traits&lt;RandomAccessIter&gt;::value_type &gt;::is_iec559, void &gt;::type boost::sort::spreadsort </td>
  1014. <td>(</td>
  1015. <td class="paramtype">RandomAccessIter&#160;</td>
  1016. <td class="paramname"><em>first</em>, </td>
  1017. </tr>
  1018. <tr>
  1019. <td class="paramkey"></td>
  1020. <td></td>
  1021. <td class="paramtype">RandomAccessIter&#160;</td>
  1022. <td class="paramname"><em>last</em>&#160;</td>
  1023. </tr>
  1024. <tr>
  1025. <td></td>
  1026. <td>)</td>
  1027. <td></td><td></td>
  1028. </tr>
  1029. </table>
  1030. </td>
  1031. <td class="mlabels-right">
  1032. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1033. </tr>
  1034. </table>
  1035. </div><div class="memdoc">
  1036. <p>Generic <code>spreadsort</code> variant detecting float element type so call to <code>float_sort</code>. </p>
  1037. <p>If the data type provided is a float or castable-float, <code>float_sort</code> is used. </p><dl class="section note"><dt>Note</dt><dd>Sorting other data types requires picking between <code>integer_sort</code>, <code>float_sort</code> and <code>string_sort</code> directly, as <code>spreadsort</code> won't accept types that don't have the appropriate <code>type_traits</code>.</dd></dl>
  1038. <dl class="tparams"><dt>Template Parameters</dt><dd>
  1039. <table class="tparams">
  1040. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  1041. </table>
  1042. </dd>
  1043. </dl>
  1044. <dl class="params"><dt>Parameters</dt><dd>
  1045. <table class="params">
  1046. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  1047. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data.</td></tr>
  1048. </table>
  1049. </dd>
  1050. </dl>
  1051. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  1052. <dd>
  1053. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  1054. <dd>
  1055. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  1056. <dd>
  1057. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  1058. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order. </dd></dl>
  1059. </div>
  1060. </div>
  1061. <a class="anchor" id="aafdea66d9b4a7faef5604b3079b525fa"></a>
  1062. <div class="memitem">
  1063. <div class="memproto">
  1064. <div class="memtemplate">
  1065. template&lt;class RandomAccessIter &gt; </div>
  1066. <table class="mlabels">
  1067. <tr>
  1068. <td class="mlabels-left">
  1069. <table class="memname">
  1070. <tr>
  1071. <td class="memname">boost::enable_if_c&lt; is_same&lt;typename std::iterator_traits&lt;RandomAccessIter&gt;::value_type, typename std::string&gt;::value || is_same&lt;typename std::iterator_traits&lt;RandomAccessIter&gt;::value_type, typename std::wstring&gt;::value, void &gt;::type boost::sort::spreadsort </td>
  1072. <td>(</td>
  1073. <td class="paramtype">RandomAccessIter&#160;</td>
  1074. <td class="paramname"><em>first</em>, </td>
  1075. </tr>
  1076. <tr>
  1077. <td class="paramkey"></td>
  1078. <td></td>
  1079. <td class="paramtype">RandomAccessIter&#160;</td>
  1080. <td class="paramname"><em>last</em>&#160;</td>
  1081. </tr>
  1082. <tr>
  1083. <td></td>
  1084. <td>)</td>
  1085. <td></td><td></td>
  1086. </tr>
  1087. </table>
  1088. </td>
  1089. <td class="mlabels-right">
  1090. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1091. </tr>
  1092. </table>
  1093. </div><div class="memdoc">
  1094. <p>Generic <code>spreadsort</code> variant detecting string element type so call to <code>string_sort</code> for <code>std::strings</code> and <code>std::wstrings</code>. </p>
  1095. <p>If the data type provided is a string or wstring, <code>string_sort</code> is used. </p><dl class="section note"><dt>Note</dt><dd>Sorting other data types requires picking between <code>integer_sort</code>, <code>float_sort</code> and <code>string_sort</code> directly, as <code>spreadsort</code> won't accept types that don't have the appropriate <code>type_traits</code>.</dd></dl>
  1096. <dl class="tparams"><dt>Template Parameters</dt><dd>
  1097. <table class="tparams">
  1098. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  1099. </table>
  1100. </dd>
  1101. </dl>
  1102. <dl class="params"><dt>Parameters</dt><dd>
  1103. <table class="params">
  1104. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  1105. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data.</td></tr>
  1106. </table>
  1107. </dd>
  1108. </dl>
  1109. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  1110. <dd>
  1111. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  1112. <dd>
  1113. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  1114. <dd>
  1115. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  1116. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order. </dd></dl>
  1117. </div>
  1118. </div>
  1119. <a class="anchor" id="a950a2dbbe75f048a0b343dbf7c532dc0"></a>
  1120. <div class="memitem">
  1121. <div class="memproto">
  1122. <div class="memtemplate">
  1123. template&lt;class RandomAccessIter , class Unsigned_char_type &gt; </div>
  1124. <table class="mlabels">
  1125. <tr>
  1126. <td class="mlabels-left">
  1127. <table class="memname">
  1128. <tr>
  1129. <td class="memname">void boost::sort::string_sort </td>
  1130. <td>(</td>
  1131. <td class="paramtype">RandomAccessIter&#160;</td>
  1132. <td class="paramname"><em>first</em>, </td>
  1133. </tr>
  1134. <tr>
  1135. <td class="paramkey"></td>
  1136. <td></td>
  1137. <td class="paramtype">RandomAccessIter&#160;</td>
  1138. <td class="paramname"><em>last</em>, </td>
  1139. </tr>
  1140. <tr>
  1141. <td class="paramkey"></td>
  1142. <td></td>
  1143. <td class="paramtype">Unsigned_char_type&#160;</td>
  1144. <td class="paramname"><em>unused</em>&#160;</td>
  1145. </tr>
  1146. <tr>
  1147. <td></td>
  1148. <td>)</td>
  1149. <td></td><td></td>
  1150. </tr>
  1151. </table>
  1152. </td>
  1153. <td class="mlabels-right">
  1154. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1155. </tr>
  1156. </table>
  1157. </div><div class="memdoc">
  1158. <p>String sort algorithm using random access iterators, allowing character-type overloads.<br />
  1159. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). </p>
  1160. <p><code>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>std::sort</code> for large tests (&gt;=100kB).<br />
  1161. </p><dl class="section user"><dt></dt><dd>Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  1162. <br />
  1163. Some performance plots of runtime vs. n and log(range) are provided:<br />
  1164. <a href="../../doc/graph/windows_string_sort.htm">windows_string_sort</a><br />
  1165. <a href="../../doc/graph/osx_string_sort.htm">osx_string_sort</a></dd></dl>
  1166. <dl class="tparams"><dt>Template Parameters</dt><dd>
  1167. <table class="tparams">
  1168. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  1169. <tr><td class="paramname">Unsigned_char_type</td><td>Unsigned character type used for string. </td></tr>
  1170. </table>
  1171. </dd>
  1172. </dl>
  1173. <dl class="params"><dt>Parameters</dt><dd>
  1174. <table class="params">
  1175. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  1176. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  1177. <tr><td class="paramdir">[in]</td><td class="paramname">unused</td><td>Unused ???</td></tr>
  1178. </table>
  1179. </dd>
  1180. </dl>
  1181. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  1182. <dd>
  1183. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  1184. <dd>
  1185. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  1186. <dd>
  1187. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  1188. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  1189. <dl class="exception"><dt>Exceptions</dt><dd>
  1190. <table class="exception">
  1191. <tr><td class="paramname">std::exception</td><td>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></tr>
  1192. </table>
  1193. </dd>
  1194. </dl>
  1195. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  1196. <dd>
  1197. Invalid arguments cause undefined behaviour. </dd></dl>
  1198. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  1199. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  1200. <dd>
  1201. * N is <code>last</code> - <code>first</code>, </dd>
  1202. <dd>
  1203. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  1204. <dd>
  1205. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  1206. </div>
  1207. </div>
  1208. <a class="anchor" id="a6acd5fc94521b0a5cb47dc491b6d862f"></a>
  1209. <div class="memitem">
  1210. <div class="memproto">
  1211. <div class="memtemplate">
  1212. template&lt;class RandomAccessIter &gt; </div>
  1213. <table class="mlabels">
  1214. <tr>
  1215. <td class="mlabels-left">
  1216. <table class="memname">
  1217. <tr>
  1218. <td class="memname">void boost::sort::string_sort </td>
  1219. <td>(</td>
  1220. <td class="paramtype">RandomAccessIter&#160;</td>
  1221. <td class="paramname"><em>first</em>, </td>
  1222. </tr>
  1223. <tr>
  1224. <td class="paramkey"></td>
  1225. <td></td>
  1226. <td class="paramtype">RandomAccessIter&#160;</td>
  1227. <td class="paramname"><em>last</em>&#160;</td>
  1228. </tr>
  1229. <tr>
  1230. <td></td>
  1231. <td>)</td>
  1232. <td></td><td></td>
  1233. </tr>
  1234. </table>
  1235. </td>
  1236. <td class="mlabels-right">
  1237. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1238. </tr>
  1239. </table>
  1240. </div><div class="memdoc">
  1241. <p>String sort algorithm using random access iterators, wraps using default of unsigned char. (All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>). </p>
  1242. <p><code>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>std::sort</code> for large tests (&gt;=100kB).<br />
  1243. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  1244. <br />
  1245. Some performance plots of runtime vs. n and log(range) are provided:<br />
  1246. <a href="../../doc/graph/windows_string_sort.htm">windows_string_sort</a> <br />
  1247. <a href="../../doc/graph/osx_string_sort.htm">osx_string_sort</a></p>
  1248. <dl class="tparams"><dt>Template Parameters</dt><dd>
  1249. <table class="tparams">
  1250. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  1251. </table>
  1252. </dd>
  1253. </dl>
  1254. <dl class="params"><dt>Parameters</dt><dd>
  1255. <table class="params">
  1256. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  1257. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data.</td></tr>
  1258. </table>
  1259. </dd>
  1260. </dl>
  1261. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  1262. <dd>
  1263. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  1264. <dd>
  1265. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  1266. <dd>
  1267. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  1268. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  1269. <dl class="exception"><dt>Exceptions</dt><dd>
  1270. <table class="exception">
  1271. <tr><td class="paramname">std::exception</td><td>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></tr>
  1272. </table>
  1273. </dd>
  1274. </dl>
  1275. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  1276. <dd>
  1277. Invalid arguments cause undefined behaviour. </dd></dl>
  1278. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  1279. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  1280. <dd>
  1281. * N is <code>last</code> - <code>first</code>, </dd>
  1282. <dd>
  1283. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  1284. <dd>
  1285. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  1286. </div>
  1287. </div>
  1288. <a class="anchor" id="a5143ec4f58cfe13eca2a0d6b6f6a6680"></a>
  1289. <div class="memitem">
  1290. <div class="memproto">
  1291. <div class="memtemplate">
  1292. template&lt;class RandomAccessIter , class Get_char , class Get_length &gt; </div>
  1293. <table class="mlabels">
  1294. <tr>
  1295. <td class="mlabels-left">
  1296. <table class="memname">
  1297. <tr>
  1298. <td class="memname">void boost::sort::string_sort </td>
  1299. <td>(</td>
  1300. <td class="paramtype">RandomAccessIter&#160;</td>
  1301. <td class="paramname"><em>first</em>, </td>
  1302. </tr>
  1303. <tr>
  1304. <td class="paramkey"></td>
  1305. <td></td>
  1306. <td class="paramtype">RandomAccessIter&#160;</td>
  1307. <td class="paramname"><em>last</em>, </td>
  1308. </tr>
  1309. <tr>
  1310. <td class="paramkey"></td>
  1311. <td></td>
  1312. <td class="paramtype">Get_char&#160;</td>
  1313. <td class="paramname"><em>get_character</em>, </td>
  1314. </tr>
  1315. <tr>
  1316. <td class="paramkey"></td>
  1317. <td></td>
  1318. <td class="paramtype">Get_length&#160;</td>
  1319. <td class="paramname"><em>length</em>&#160;</td>
  1320. </tr>
  1321. <tr>
  1322. <td></td>
  1323. <td>)</td>
  1324. <td></td><td></td>
  1325. </tr>
  1326. </table>
  1327. </td>
  1328. <td class="mlabels-right">
  1329. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1330. </tr>
  1331. </table>
  1332. </div><div class="memdoc">
  1333. <p>String sort algorithm using random access iterators, wraps using default of <code>unsigned</code> char. </p>
  1334. <p>(All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>).</p>
  1335. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  1336. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  1337. <br />
  1338. Some performance plots of runtime vs. n and log(range) are provided:<br />
  1339. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  1340. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  1341. <dl class="tparams"><dt>Template Parameters</dt><dd>
  1342. <table class="tparams">
  1343. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  1344. <tr><td class="paramname">Get_char</td><td>Bracket functor equivalent to <code>operator</code>[], taking a number corresponding to the character offset.. </td></tr>
  1345. <tr><td class="paramname">Get_length</td><td>Functor to get the length of the string in characters. TODO Check this and below and other places!!!</td></tr>
  1346. </table>
  1347. </dd>
  1348. </dl>
  1349. <dl class="params"><dt>Parameters</dt><dd>
  1350. <table class="params">
  1351. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  1352. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  1353. <tr><td class="paramdir">[in]</td><td class="paramname">get_character</td><td>Number corresponding to the character offset from bracket functor equivalent to <code>operator</code>[]. </td></tr>
  1354. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Functor to get the length of the string in characters.</td></tr>
  1355. </table>
  1356. </dd>
  1357. </dl>
  1358. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  1359. <dd>
  1360. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  1361. <dd>
  1362. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd>
  1363. <dd>
  1364. <code>RandomAccessIter</code> <code>value_type</code> supports the <code>operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </dd></dl>
  1365. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  1366. <dl class="section return"><dt>Returns</dt><dd><code>void</code>.</dd></dl>
  1367. <dl class="exception"><dt>Exceptions</dt><dd>
  1368. <table class="exception">
  1369. <tr><td class="paramname">std::exception</td><td>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></tr>
  1370. </table>
  1371. </dd>
  1372. </dl>
  1373. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  1374. <dd>
  1375. Invalid arguments cause undefined behaviour. </dd></dl>
  1376. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  1377. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  1378. <dd>
  1379. * N is <code>last</code> - <code>first</code>, </dd>
  1380. <dd>
  1381. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  1382. <dd>
  1383. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  1384. </div>
  1385. </div>
  1386. <a class="anchor" id="a82c4c0d7ba9873ecce7c674631dceae2"></a>
  1387. <div class="memitem">
  1388. <div class="memproto">
  1389. <div class="memtemplate">
  1390. template&lt;class RandomAccessIter , class Get_char , class Get_length , class Compare &gt; </div>
  1391. <table class="mlabels">
  1392. <tr>
  1393. <td class="mlabels-left">
  1394. <table class="memname">
  1395. <tr>
  1396. <td class="memname">void boost::sort::string_sort </td>
  1397. <td>(</td>
  1398. <td class="paramtype">RandomAccessIter&#160;</td>
  1399. <td class="paramname"><em>first</em>, </td>
  1400. </tr>
  1401. <tr>
  1402. <td class="paramkey"></td>
  1403. <td></td>
  1404. <td class="paramtype">RandomAccessIter&#160;</td>
  1405. <td class="paramname"><em>last</em>, </td>
  1406. </tr>
  1407. <tr>
  1408. <td class="paramkey"></td>
  1409. <td></td>
  1410. <td class="paramtype">Get_char&#160;</td>
  1411. <td class="paramname"><em>get_character</em>, </td>
  1412. </tr>
  1413. <tr>
  1414. <td class="paramkey"></td>
  1415. <td></td>
  1416. <td class="paramtype">Get_length&#160;</td>
  1417. <td class="paramname"><em>length</em>, </td>
  1418. </tr>
  1419. <tr>
  1420. <td class="paramkey"></td>
  1421. <td></td>
  1422. <td class="paramtype">Compare&#160;</td>
  1423. <td class="paramname"><em>comp</em>&#160;</td>
  1424. </tr>
  1425. <tr>
  1426. <td></td>
  1427. <td>)</td>
  1428. <td></td><td></td>
  1429. </tr>
  1430. </table>
  1431. </td>
  1432. <td class="mlabels-right">
  1433. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1434. </tr>
  1435. </table>
  1436. </div><div class="memdoc">
  1437. <p>String sort algorithm using random access iterators, wraps using default of <code>unsigned</code> char. </p>
  1438. <p>(All variants fall back to <code>std::sort</code> if the data size is too small, &lt; <code>detail::min_sort_size</code>).</p>
  1439. <p><code>integer_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>std::sort</code> for large tests (&gt;=100kB).<br />
  1440. Worst-case performance is <em> O(N * (lg(range)/s + s)) </em>, so <code>integer_sort</code> is asymptotically faster than pure comparison-based algorithms. <code>s</code> is <code>max_splits</code>, which defaults to 11, so its worst-case with default settings for 32-bit integers is <em> O(N * ((32/11) </em> slow radix-based iterations fast comparison-based iterations).<br />
  1441. <br />
  1442. Some performance plots of runtime vs. n and log(range) are provided:<br />
  1443. <a href="../../doc/graph/windows_integer_sort.htm">windows_integer_sort</a> <br />
  1444. <a href="../../doc/graph/osx_integer_sort.htm">osx_integer_sort</a></p>
  1445. <dl class="tparams"><dt>Template Parameters</dt><dd>
  1446. <table class="tparams">
  1447. <tr><td class="paramname">RandomAccessIter</td><td><a href="http://www.cplusplus.com/reference/iterator/RandomAccessIterator/">Random access iterator</a> </td></tr>
  1448. <tr><td class="paramname">Get_char</td><td>???. </td></tr>
  1449. <tr><td class="paramname">Get_length</td><td>??? TODO </td></tr>
  1450. <tr><td class="paramname">Comp</td><td>To provide <code>operator&lt;</code> for user-defined comparison.</td></tr>
  1451. </table>
  1452. </dd>
  1453. </dl>
  1454. <dl class="params"><dt>Parameters</dt><dd>
  1455. <table class="params">
  1456. <tr><td class="paramdir">[in]</td><td class="paramname">first</td><td>Iterator pointer to first element. </td></tr>
  1457. <tr><td class="paramdir">[in]</td><td class="paramname">last</td><td>Iterator pointing to one beyond the end of data. </td></tr>
  1458. <tr><td class="paramdir">[in]</td><td class="paramname">comp</td><td>comparison functor. </td></tr>
  1459. <tr><td class="paramdir">[in]</td><td class="paramname">get_character</td><td>??? </td></tr>
  1460. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>???</td></tr>
  1461. </table>
  1462. </dd>
  1463. </dl>
  1464. <dl class="section pre"><dt>Precondition</dt><dd>[<code>first</code>, <code>last</code>) is a valid range. </dd>
  1465. <dd>
  1466. <code>RandomAccessIter</code> <code>value_type</code> is mutable. </dd>
  1467. <dd>
  1468. <code>RandomAccessIter</code> <code>value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable">LessThanComparable</a> </dd></dl>
  1469. <dl class="section post"><dt>Postcondition</dt><dd>The elements in the range [<code>first</code>, <code>last</code>) are sorted in ascending order.</dd></dl>
  1470. <dl class="section return"><dt>Returns</dt><dd><code>void</code>.</dd></dl>
  1471. <dl class="exception"><dt>Exceptions</dt><dd>
  1472. <table class="exception">
  1473. <tr><td class="paramname">std::exception</td><td>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></tr>
  1474. </table>
  1475. </dd>
  1476. </dl>
  1477. <dl class="section warning"><dt>Warning</dt><dd>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. </dd>
  1478. <dd>
  1479. Invalid arguments cause undefined behaviour. </dd></dl>
  1480. <dl class="section note"><dt>Note</dt><dd><code>spreadsort</code> function provides a wrapper that calls the fastest sorting algorithm available for a data type, enabling faster generic-programming.</dd></dl>
  1481. <dl class="section remark"><dt>Remarks</dt><dd>The lesser of <em> O(N*log(N)) </em> comparisons and <em> O(N*log(K/S + S)) </em>operations worst-case, where: </dd>
  1482. <dd>
  1483. * N is <code>last</code> - <code>first</code>, </dd>
  1484. <dd>
  1485. * K is the log of the range in bits (32 for 32-bit integers using their full range), </dd>
  1486. <dd>
  1487. * S is a constant called max_splits, defaulting to 11 (except for strings where it is the log of the character size). </dd></dl>
  1488. </div>
  1489. </div>
  1490. </div><!-- contents -->
  1491. <!-- start footer part -->
  1492. <hr class="footer"/><address class="footer"><small>
  1493. Generated on Fri Jan 9 2015 14:20:24 for Boost.Sort by &#160;<a href="http://www.doxygen.org/index.html">
  1494. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1495. </a> 1.8.9.1
  1496. </small></address>
  1497. </body>
  1498. </html>