libs/range/doc/html/range/reference/algorithms/non_mutating/lexicographical_compare.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>lexicographical_compare</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Range 2.0">
   8 <link rel="up" href="../non_mutating.html" title="Non-mutating algorithms">
   9 <link rel="prev" href="find_if.html" title="find_if">
  10 <link rel="next" href="lower_bound.html" title="lower_bound">
  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="find_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_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="lower_bound.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.non_mutating.lexicographical_compare"></a><a class="link" href="lexicographical_compare.html" title="lexicographical_compare">lexicographical_compare</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="range.reference.algorithms.non_mutating.lexicographical_compare.h0"></a>
  31             <span class="phrase"><a name="range.reference.algorithms.non_mutating.lexicographical_compare.prototype"></a></span><a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.prototype">Prototype</a>
  32           </h6>
  33 <p>
  34 </p>
  35 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  36     <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
  37     <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span>
  38     <span class="special">&gt;</span>
  39 <span class="keyword">bool</span> <span class="identifier">lexicographical_compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span>
  40                              <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">);</span>
  41
  42 <span class="keyword">template</span><span class="special">&lt;</span>
  43     <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span>
  44     <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span>
  45     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  46     <span class="special">&gt;</span>
  47 <span class="keyword">bool</span> <span class="identifier">lexicographical_compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&amp;</span> <span class="identifier">rng1</span><span class="special">,</span>
  48                              <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&amp;</span> <span class="identifier">rng2</span><span class="special">,</span>
  49                              <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span>
  50 </pre>
  51 <p>
  52           </p>
  53 <h6>
  54 <a name="range.reference.algorithms.non_mutating.lexicographical_compare.h1"></a>
  55             <span class="phrase"><a name="range.reference.algorithms.non_mutating.lexicographical_compare.description"></a></span><a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.description">Description</a>
  56           </h6>
  57 <p>
  58             <code class="computeroutput"><span class="identifier">lexicographical_compare</span></code>
  59             compares element by element <code class="computeroutput"><span class="identifier">rng1</span></code>
  60             against <code class="computeroutput"><span class="identifier">rng2</span></code>. If the
  61             element from <code class="computeroutput"><span class="identifier">rng1</span></code> is
  62             less than the element from <code class="computeroutput"><span class="identifier">rng2</span></code>
  63             then <code class="computeroutput"><span class="keyword">true</span></code> is returned. If
  64             the end of <code class="computeroutput"><span class="identifier">rng1</span></code> without
  65             reaching the end of <code class="computeroutput"><span class="identifier">rng2</span></code>
  66             this also causes the return value to be <code class="computeroutput"><span class="keyword">true</span></code>.
  67             The return value is <code class="computeroutput"><span class="keyword">false</span></code>
  68             in all other circumstances. The elements are compared using <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code>
  69             in the non-predicate versions of <code class="computeroutput"><span class="identifier">lexicographical_compare</span></code>
  70             and using <code class="computeroutput"><span class="identifier">pred</span></code> in the
  71             predicate versions.
  72           </p>
  73 <h6>
  74 <a name="range.reference.algorithms.non_mutating.lexicographical_compare.h2"></a>
  75             <span class="phrase"><a name="range.reference.algorithms.non_mutating.lexicographical_compare.definition"></a></span><a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.definition">Definition</a>
  76           </h6>
  77 <p>
  78             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">lexicographical_compare</span><span class="special">.</span><span class="identifier">hpp</span></code>
  79           </p>
  80 <h6>
  81 <a name="range.reference.algorithms.non_mutating.lexicographical_compare.h3"></a>
  82             <span class="phrase"><a name="range.reference.algorithms.non_mutating.lexicographical_compare.requirements"></a></span><a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.requirements">Requirements</a>
  83           </h6>
  84 <p>
  85             <span class="bold"><strong>For the non-predicate versions of lexicographical_compare:</strong></span>
  86           </p>
  87 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  88 <li class="listitem">
  89                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>
  90                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
  91                 Pass Range</a> Concept.
  92               </li>
  93 <li class="listitem">
  94                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>
  95                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
  96                 Pass Range</a> Concept.
  97               </li>
  98 <li class="listitem">
  99                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
 100                 value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>.
 101               </li>
 102 <li class="listitem">
 103                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
 104                 value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>.
 105               </li>
 106 <li class="listitem">
 107                 Let <code class="computeroutput"><span class="identifier">x</span></code> be an object
 108                 of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
 109                 value type. Let <code class="computeroutput"><span class="identifier">y</span></code>
 110                 be an object of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
 111                 value type. <code class="computeroutput"><span class="identifier">x</span> <span class="special">&lt;</span>
 112                 <span class="identifier">y</span></code> must be valid. <code class="computeroutput"><span class="identifier">y</span> <span class="special">&lt;</span>
 113                 <span class="identifier">x</span></code> must be valid.
 114               </li>
 115 </ul></div>
 116 <p>
 117             <span class="bold"><strong>For the predicate versions of lexicographical_compare:</strong></span>
 118           </p>
 119 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 120 <li class="listitem">
 121                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>
 122                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
 123                 Pass Range</a> Concept.
 124               </li>
 125 <li class="listitem">
 126                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>
 127                 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
 128                 Pass Range</a> Concept.
 129               </li>
 130 <li class="listitem">
 131                 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
 132                 a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>.
 133               </li>
 134 <li class="listitem">
 135                 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
 136                 value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 137                 first argument type.
 138               </li>
 139 <li class="listitem">
 140                 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
 141                 value type is convertible to <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 142                 second argument type.
 143               </li>
 144 </ul></div>
 145 <h6>
 146 <a name="range.reference.algorithms.non_mutating.lexicographical_compare.h4"></a>
 147             <span class="phrase"><a name="range.reference.algorithms.non_mutating.lexicographical_compare.complexity"></a></span><a class="link" href="lexicographical_compare.html#range.reference.algorithms.non_mutating.lexicographical_compare.complexity">Complexity</a>
 148           </h6>
 149 <p>
 150             Linear. At most <code class="computeroutput"><span class="number">2</span> <span class="special">*</span>
 151             <span class="identifier">min</span><span class="special">(</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">),</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code>
 152             comparisons.
 153           </p>
 154 </div>
 155 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 156 <td align="left"></td>
 157 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
 158       Neil Groves<p>
 159         Distributed under the Boost Software License, Version 1.0. (See accompanying
 160         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>)
 161       </p>
 162 </div></td>
 163 </tr></table>
 164 <hr>
 165 <div class="spirit-nav">
 166 <a accesskey="p" href="find_if.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_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="lower_bound.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 167 </div>
 168 </body>
 169 </html>