/Src/Dependencies/Boost/libs/range/doc/html/range/reference/algorithms/new/is_sorted.html

http://hadesmem.googlecode.com/ · HTML · 108 lines · 106 code · 2 blank · 0 comment · 0 complexity · 46568eb4b685135445910381400b24a1 MD5 · raw file

  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>is_sorted</title>
  5. <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
  7. <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Range 2.0">
  8. <link rel="up" href="../new.html" title="New algorithms">
  9. <link rel="prev" href="iota.html" title="iota">
  10. <link rel="next" href="overwrite.html" title="overwrite">
  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="iota.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.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="overwrite.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h5 class="title">
  27. <a name="range.reference.algorithms.new.is_sorted"></a><a class="link" href="is_sorted.html" title="is_sorted">is_sorted</a>
  28. </h5></div></div></div>
  29. <a name="range.reference.algorithms.new.is_sorted.prototype"></a><h6>
  30. <a name="id747924"></a>
  31. <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.prototype">Prototype</a>
  32. </h6>
  33. <p>
  34. </p>
  35. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">&gt;</span>
  36. <span class="keyword">bool</span> <span class="identifier">is_sorted</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
  37. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
  38. <span class="keyword">bool</span> <span class="identifier">is_sorted</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  39. </pre>
  40. <p>
  41. </p>
  42. <a name="range.reference.algorithms.new.is_sorted.description"></a><h6>
  43. <a name="id748118"></a>
  44. <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.description">Description</a>
  45. </h6>
  46. <p>
  47. <code class="computeroutput"><span class="identifier">is_sorted</span></code> determines
  48. if a range is sorted. For the non-predicate version the return value
  49. is <code class="computeroutput"><span class="keyword">true</span></code> if and only if for
  50. each adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>
  51. the expression <code class="computeroutput"><span class="identifier">x</span> <span class="special">&lt;</span>
  52. <span class="identifier">y</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>.
  53. For the predicate version the return value is <code class="computeroutput"><span class="keyword">true</span></code>
  54. is and only if for each adjacent elements <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>
  55. the expression <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span></code>
  56. is <code class="computeroutput"><span class="keyword">true</span></code>.
  57. </p>
  58. <a name="range.reference.algorithms.new.is_sorted.definition"></a><h6>
  59. <a name="id748306"></a>
  60. <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.definition">Definition</a>
  61. </h6>
  62. <p>
  63. 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_ext</span><span class="special">/</span><span class="identifier">is_sorted</span><span class="special">.</span><span class="identifier">hpp</span></code>
  64. </p>
  65. <a name="range.reference.algorithms.new.is_sorted.requirements"></a><h6>
  66. <a name="id748376"></a>
  67. <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.requirements">Requirements</a>
  68. </h6>
  69. <div class="orderedlist"><ol class="orderedlist" type="1">
  70. <li class="listitem">
  71. <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is
  72. a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
  73. Pass Range</a> Concept.
  74. </li>
  75. <li class="listitem">
  76. <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
  77. a model of the <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>
  78. Concept.
  79. </li>
  80. <li class="listitem">
  81. The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>
  82. is convertible to both argument types of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>.
  83. </li>
  84. </ol></div>
  85. <a name="range.reference.algorithms.new.is_sorted.complexity"></a><h6>
  86. <a name="id748485"></a>
  87. <a class="link" href="is_sorted.html#range.reference.algorithms.new.is_sorted.complexity">Complexity</a>
  88. </h6>
  89. <p>
  90. Linear. A maximum of <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> comparisons are performed.
  91. </p>
  92. </div>
  93. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  94. <td align="left"></td>
  95. <td align="right"><div class="copyright-footer">Copyright &#169; 2003 -2010 Thorsten Ottosen, Neil Groves<p>
  96. Distributed under the Boost Software License, Version 1.0. (See accompanying
  97. 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>)
  98. </p>
  99. </div></td>
  100. </tr></table>
  101. <hr>
  102. <div class="spirit-nav">
  103. <a accesskey="p" href="iota.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.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="overwrite.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  104. </div>
  105. </body>
  106. </html>