libs/sort/doc/html/sort/single_thread/spreadsort/sort_hpp.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Spreadsort</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Boost.Sort">
   8 <link rel="up" href="../spreadsort.html" title="2.1.-Spreadsort">
   9 <link rel="prev" href="../spreadsort.html" title="2.1.-Spreadsort">
  10 <link rel="next" href="sort_hpp/integer_sort.html" title="Integer Sort">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../spreadsort.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../spreadsort.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort_hpp/integer_sort.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="sort.single_thread.spreadsort.sort_hpp"></a><a class="link" href="sort_hpp.html" title="Spreadsort">Spreadsort</a>
  28 </h4></div></div></div>
  29 <div class="section">
  30 <div class="titlepage"><div><div><h5 class="title">
  31 <a name="sort.single_thread.spreadsort.sort_hpp.header_spreadsort"></a><a class="link" href="sort_hpp.html#sort.single_thread.spreadsort.sort_hpp.header_spreadsort" title="Header &lt;boost/sort/spreadsort/spreadsort.hpp&gt;">Header
  32           <code class="computeroutput">&lt;boost/sort/spreadsort/spreadsort.hpp&gt;</code></a>
  33 </h5></div></div></div>
  34 <p>
  35             <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/spreadso_idm46048203074304.html" title="Function template spreadsort">spreadsort</a></code></code>
  36             checks whether the data-type provided is an integer, castable float,
  37             string, or wstring.
  38           </p>
  39 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  40 <li class="listitem">
  41                 If data-type is an integer, <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/integer__idm46048203222928.html" title="Function template integer_sort">integer_sort</a></code></code>
  42                 is used.
  43               </li>
  44 <li class="listitem">
  45                 If data-type is a float, <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/float_so_idm46048204416688.html" title="Function template float_sort">float_sort</a></code></code>
  46                 is used.
  47               </li>
  48 <li class="listitem">
  49                 If data-type is a string or wstring, <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/string_s_idm46048202990736.html" title="Function template string_sort">string_sort</a></code></code>
  50                 is used.
  51               </li>
  52 <li class="listitem">
  53                 Sorting other data-types requires picking between <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/integer__idm46048203222928.html" title="Function template integer_sort">integer_sort</a></code></code>,
  54                 <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/float_so_idm46048204416688.html" title="Function template float_sort">float_sort</a></code></code>
  55                 and <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/string_s_idm46048202990736.html" title="Function template string_sort">string_sort</a></code></code>
  56                 directly, as <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/spreadso_idm46048203074304.html" title="Function template spreadsort">spreadsort</a></code></code>
  57                 won't accept types that don't have the appropriate type traits.
  58               </li>
  59 </ul></div>
  60 <p>
  61             Overloading variants are provided that permit use of user-defined right-shift
  62             functors and comparison functors.
  63           </p>
  64 <p>
  65             Each function is optimized for its set of arguments; default functors
  66             are not provided to avoid the risk of any reduction of performance.
  67           </p>
  68 <p>
  69             See <a class="link" href="../../../">overloading</a> section.
  70           </p>
  71 <h6>
  72 <a name="sort.single_thread.spreadsort.sort_hpp.header_spreadsort.h0"></a>
  73             <span class="phrase"><a name="sort.single_thread.spreadsort.sort_hpp.header_spreadsort.rationale"></a></span><a class="link" href="sort_hpp.html#sort.single_thread.spreadsort.sort_hpp.header_spreadsort.rationale">Rationale:</a>
  74           </h6>
  75 <p>
  76             <code class="literal"><code class="computeroutput"><a class="link" href="../../../boost/sort/spreadsort/spreadso_idm46048203074304.html" title="Function template spreadsort">spreadsort</a></code></code>
  77             function provides a wrapper that calls the fastest sorting algorithm
  78             available for a data-type, enabling faster generic programming.
  79           </p>
  80 <div class="section">
  81 <div class="titlepage"><div><div><h6 class="title">
  82 <a name="sort.single_thread.spreadsort.sort_hpp.header_spreadsort.spreadsort_examples"></a><a class="link" href="sort_hpp.html#sort.single_thread.spreadsort.sort_hpp.header_spreadsort.spreadsort_examples" title="Spreadsort Examples">Spreadsort
  83             Examples</a>
  84 </h6></div></div></div>
  85 <p>
  86               See <a href="../../../../../example/" target="_top">example</a> folder for all examples.
  87             </p>
  88 <p>
  89               See <a href="../../../../../example/sample.cpp" target="_top">sample.cpp</a> for a
  90               simple working example.
  91             </p>
  92 <p>
  93               For an example of 64-bit integer sorting, see <a href="../../../../../example/int64.cpp" target="_top">int64.cpp</a>.
  94             </p>
  95 <p>
  96               This example sets the element type of a vector to 64-bit integer
  97             </p>
  98 <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">DATA_TYPE</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">int64_t</span>
  99 </pre>
 100 <p>
 101               and calls the sort
 102             </p>
 103 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">sort</span><span class="special">::</span><span class="identifier">spreadsort</span><span class="special">::</span><span class="identifier">spreadsort</span><span class="special">(</span><span class="identifier">array</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">array</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span>
 104 </pre>
 105 <p>
 106               For a simple example sorting <code class="computeroutput">float</code>s,
 107             </p>
 108 <pre class="programlisting">vector&lt;float&gt; vec;
 109 vec.push_back(1.0);
 110 vec.push_back(2.3);
 111 vec.push_back(1.3);
 112 ...
 113 spreadsort(vec.begin(), vec.end());
 114 //The sorted vector contains "1.0 1.3 2.3 ..."
 115 </pre>
 116 <p>
 117               See also <a href="../../../../../example/floatsample.cpp" target="_top">floatsample.cpp</a>
 118               which checks for abnormal values.
 119             </p>
 120 </div>
 121 </div>
 122 </div>
 123 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 124 <td align="left"></td>
 125 <td align="right"><div class="copyright-footer">Copyright &#169; 2014-2017 Steven
 126       Ross, Francisco Tapia, Orson Peters<p>
 127         Distributed under the <a href="http://boost.org/LICENSE_1_0.txt" target="_top">Boost
 128         Software License, Version 1.0</a>.
 129       </p>
 130 </div></td>
 131 </tr></table>
 132 <hr>
 133 <div class="spirit-nav">
 134 <a accesskey="p" href="../spreadsort.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../spreadsort.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="sort_hpp/integer_sort.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 135 </div>
 136 </body>
 137 </html>