/Src/Dependencies/Boost/libs/range/doc/html/range/reference/algorithms/mutating/nth_element.html

http://hadesmem.googlecode.com/ · HTML · 150 lines · 146 code · 4 blank · 0 comment · 0 complexity · c79c20d8a46662c51481913a87108f0a MD5 · raw file 

    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>nth_element</title>
    5. 

  5. <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    7. 

  7. <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Range 2.0">
    8. 

  8. <link rel="up" href="../mutating.html" title="Mutating algorithms">
    9. 

  9. <link rel="prev" href="merge.html" title="merge">
    10. 

  10. <link rel="next" href="partial_sort.html" title="partial_sort">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="partial_sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h5 class="title">
    27. 

  27. <a name="range.reference.algorithms.mutating.nth_element"></a><a class="link" href="nth_element.html" title="nth_element">nth_element</a>
    28. 

  28. </h5></div></div></div>
    29. 

  29. <a name="range.reference.algorithms.mutating.nth_element.prototype"></a><h6>
    30. 

  30. <a name="id691010"></a>
    31. 

  31.             <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.prototype">Prototype</a>
    32. 

  32.           </h6>
    33. 

  33. <p>
    34. 

  34.             
    35. 

  35. </p>
    36. 

  36. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
    37. 

  37. <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">nth_element</span><span class="special">(</span>
    38. 

  38.     <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
    39. 

  39.     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">RandomAccessRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">);</span>
    40. 

  40. 

  41. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
    42. 

  42. <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">nth_element</span><span class="special">(</span>
    43. 

  43.     <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
    44. 

  44.     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">);</span>
    45. 

  45. 

  46. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
    47. 

  47. <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">nth_element</span><span class="special">(</span>
    48. 

  48.     <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
    49. 

  49.     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">RandomAccessRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">,</span>
    50. 

  50.     <span class="identifier">BinaryPredicate</span> <span class="identifier">sort_pred</span><span class="special">);</span>
    51. 

  51. 

  52. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
    53. 

  53. <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">nth_element</span><span class="special">(</span>
    54. 

  54.     <span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
    55. 

  55.     <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">nth</span><span class="special">,</span>
    56. 

  56.     <span class="identifier">BinaryPredicate</span> <span class="identifier">sort_pred</span><span class="special">);</span>
    57. 

  57. </pre>
    58. 

  58. <p>
    59. 

  59.           </p>
    60. 

  60. <a name="range.reference.algorithms.mutating.nth_element.description"></a><h6>
    61. 

  61. <a name="id691529"></a>
    62. 

  62.             <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.description">Description</a>
    63. 

  63.           </h6>
    64. 

  64. <p>
    65. 

  65.             <code class="computeroutput"><span class="identifier">nth_element</span></code> partially
    66. 

  66.             orders a range of elements. <code class="computeroutput"><span class="identifier">nth_element</span></code>
    67. 

  67.             arranges the range <code class="computeroutput"><span class="identifier">rng</span></code>
    68. 

  68.             such that the element corresponding with the iterator <code class="computeroutput"><span class="identifier">nth</span></code>
    69. 

  69.             is the same as the element that would be in that position if <code class="computeroutput"><span class="identifier">rng</span></code> has been sorted.
    70. 

  70.           </p>
    71. 

  71. <a name="range.reference.algorithms.mutating.nth_element.definition"></a><h6>
    72. 

  72. <a name="id691606"></a>
    73. 

  73.             <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.definition">Definition</a>
    74. 

  74.           </h6>
    75. 

  75. <p>
    76. 

  76.             Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">nth_element</span><span class="special">.</span><span class="identifier">hpp</span></code>
    77. 

  77.           </p>
    78. 

  78. <a name="range.reference.algorithms.mutating.nth_element.requirements"></a><h6>
    79. 

  79. <a name="id691676"></a>
    80. 

  80.             <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.requirements">Requirements</a>
    81. 

  81.           </h6>
    82. 

  82. <p>
    83. 

  83.             <span class="bold"><strong>For the non-predicate version:</strong></span>
    84. 

  84.           </p>
    85. 

  85. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    86. 

  86. <li class="listitem">
    87. 

  87.                 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
    88. 

  88.                 is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random
    89. 

  89.                 Access Range</a> Concept.
    90. 

  90.               </li>
    91. 

  91. <li class="listitem">
    92. 

  92.                 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
    93. 

  93.                 is mutable.
    94. 

  94.               </li>
    95. 

  95. <li class="listitem">
    96. 

  96.                 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s
    97. 

  97.                 value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>.
    98. 

  98.               </li>
    99. 

  99. <li class="listitem">
    100. 

  100.                 The ordering relation on <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s
    101. 

  101.                 value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>,
    102. 

  102.                 as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>
    103. 

  103.                 requirements.
    104. 

  104.               </li>
    105. 

  105. </ul></div>
    106. 

  106. <p>
    107. 

  107.             <span class="bold"><strong>For the predicate version:</strong></span>
    108. 

  108.           </p>
    109. 

  109. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    110. 

  110. <li class="listitem">
    111. 

  111.                 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
    112. 

  112.                 is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random
    113. 

  113.                 Access Range</a> Concept.
    114. 

  114.               </li>
    115. 

  115. <li class="listitem">
    116. 

  116.                 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
    117. 

  117.                 is mutable.
    118. 

  118.               </li>
    119. 

  119. <li class="listitem">
    120. 

  120.                 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
    121. 

  121.                 a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>.
    122. 

  122.               </li>
    123. 

  123. <li class="listitem">
    124. 

  124.                 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s
    125. 

  125.                 value type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
    126. 

  126.                 argument types.
    127. 

  127.               </li>
    128. 

  128. </ul></div>
    129. 

  129. <a name="range.reference.algorithms.mutating.nth_element.complexity"></a><h6>
    130. 

  130. <a name="id691923"></a>
    131. 

  131.             <a class="link" href="nth_element.html#range.reference.algorithms.mutating.nth_element.complexity">Complexity</a>
    132. 

  132.           </h6>
    133. 

  133. <p>
    134. 

  134.             On average, linear in <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>.
    135. 

  135.           </p>
    136. 

  136. </div>
    137. 

  137. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    138. 

  138. <td align="left"></td>
    139. 

  139. <td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
    140. 

  140.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    141. 

  141.         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
    142. 

  142.       </p>
    143. 

  143. </div></td>
    144. 

  144. </tr></table>
    145. 

  145. <hr>
    146. 

  146. <div class="spirit-nav">
    147. 

  147. <a accesskey="p" href="merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="partial_sort.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
    148. 

  148. </div>
    149. 

  149. </body>
    150. 

  150. </html>
    151.