libs/sort/doc/html/boost/sort/spreadsort/spreadsort_idp23536624.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template 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="../../../header/boost/sort/spreadsort/spreadsort_hpp.html" title="Header &lt;boost/sort/spreadsort/spreadsort.hpp&gt;">
   9 <link rel="prev" href="../../../header/boost/sort/spreadsort/spreadsort_hpp.html" title="Header &lt;boost/sort/spreadsort/spreadsort.hpp&gt;">
  10 <link rel="next" href="spreadsort_idp23550688.html" title="Function template spreadsort">
  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="../../../header/boost/sort/spreadsort/spreadsort_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/sort/spreadsort/spreadsort_hpp.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="spreadsort_idp23550688.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.sort.spreadsort.spreadsort_idp23536624"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template spreadsort</span></h2>
  29 <p>boost::sort::spreadsort::spreadsort &#8212; Generic <code class="computeroutput">spreadsort</code> variant detecting integer-type elements so call to <code class="computeroutput">integer_sort</code>. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../header/boost/sort/spreadsort/spreadsort_hpp.html" title="Header &lt;boost/sort/spreadsort/spreadsort.hpp&gt;">boost/sort/spreadsort/spreadsort.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RandomAccessIter<span class="special">&gt;</span>
  36   <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_c</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">numeric_limits</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special">&lt;</span> <span class="identifier">RandomAccessIter</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">is_integer</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  37   <span class="identifier">spreadsort</span><span class="special">(</span><span class="identifier">RandomAccessIter</span> first<span class="special">,</span> <span class="identifier">RandomAccessIter</span> last<span class="special">)</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="idp78703200"></a><h2>Description</h2>
  40 <p>If the data type provided is an integer, <code class="computeroutput">integer_sort</code> is used. </p>
  41 <div class="note"><table border="0" summary="Note">
  42 <tr>
  43 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  44 <th align="left">Note</th>
  45 </tr>
  46 <tr><td align="left" valign="top"><p>Sorting other data types requires picking between <code class="computeroutput">integer_sort</code>, <code class="computeroutput">float_sort</code> and <code class="computeroutput">string_sort</code> directly, as <code class="computeroutput">spreadsort</code> won't accept types that don't have the appropriate <code class="computeroutput">type_traits</code>. </p></td></tr>
  47 </table></div>
  48 <p>
  49
  50
  51
  52 </p>
  53 <div class="variablelist"><table border="0" class="variablelist compact">
  54 <colgroup>
  55 <col align="left" valign="top">
  56 <col>
  57 </colgroup>
  58 <tbody>
  59 <tr>
  60 <td><p><span class="term">Parameters:</span></p></td>
  61 <td><div class="variablelist"><table border="0" class="variablelist compact">
  62 <colgroup>
  63 <col align="left" valign="top">
  64 <col>
  65 </colgroup>
  66 <tbody>
  67 <tr>
  68 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
  69 <td><p>Iterator pointer to first element. </p></td>
  70 </tr>
  71 <tr>
  72 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
  73 <td><p>Iterator pointing to one beyond the end of data.</p></td>
  74 </tr>
  75 </tbody>
  76 </table></div></td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term">Requires:</span></p></td>
  80 <td>
  81 <p>[<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) is a valid range. </p>
  82 <p><code class="computeroutput">RandomAccessIter</code> <code class="computeroutput">value_type</code> is mutable. </p>
  83 <p><code class="computeroutput">RandomAccessIter</code> <code class="computeroutput">value_type</code> is <a href="http://en.cppreference.com/w/cpp/concept/LessThanComparable" target="_top">LessThanComparable</a> </p>
  84 <p><code class="computeroutput">RandomAccessIter</code> <code class="computeroutput">value_type</code> supports the <code class="computeroutput">operator&gt;&gt;</code>, which returns an integer-type right-shifted a specified number of bits. </p>
  85 </td>
  86 </tr>
  87 <tr>
  88 <td><p><span class="term">Postconditions:</span></p></td>
  89 <td><p>The elements in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) are sorted in ascending order. </p></td>
  90 </tr>
  91 </tbody>
  92 </table></div>
  93 </div>
  94 </div>
  95 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  96 <td align="left"></td>
  97 <td align="right"><div class="copyright-footer">Copyright &#169; 2014 Steven Ross<p>
  98         Distributed under the <a href="http://boost.org/LICENSE_1_0.txt" target="_top">Boost
  99         Software License, Version 1.0</a>.
 100       </p>
 101 </div></td>
 102 </tr></table>
 103 <hr>
 104 <div class="spirit-nav">
 105 <a accesskey="p" href="../../../header/boost/sort/spreadsort/spreadsort_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/sort/spreadsort/spreadsort_hpp.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="spreadsort_idp23550688.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 106 </div>
 107 </body>
 108 </html>