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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>min_element</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="max_element.html" title="max_element">
  10 <link rel="next" href="mismatch.html" title="mismatch">
  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="max_element.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="mismatch.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.min_element"></a><a class="link" href="min_element.html" title="min_element">min_element</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="range.reference.algorithms.non_mutating.min_element.h0"></a>
  31             <span class="phrase"><a name="range.reference.algorithms.non_mutating.min_element.prototype"></a></span><a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.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">ForwardRange</span><span class="special">&gt;</span>
  36 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
  37 <span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
  38
  39 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">&gt;</span>
  40 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
  41 <span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
  42
  43 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
  44 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
  45 <span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</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>
  46
  47 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
  48 <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span>
  49 <span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</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>
  50
  51
  52 <span class="keyword">template</span><span class="special">&lt;</span>
  53     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  54     <span class="keyword">class</span> <span class="identifier">ForwardRange</span>
  55     <span class="special">&gt;</span>
  56 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  57 <span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
  58
  59 <span class="keyword">template</span><span class="special">&lt;</span>
  60     <span class="identifier">range_return_value_re</span><span class="special">,</span>
  61     <span class="keyword">class</span> <span class="identifier">ForwardRange</span>
  62     <span class="special">&gt;</span>
  63 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  64 <span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
  65
  66 <span class="keyword">template</span><span class="special">&lt;</span>
  67     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  68     <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span>
  69     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  70     <span class="special">&gt;</span>
  71 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  72 <span class="identifier">min_element</span><span class="special">(</span><span class="identifier">ForwardRange</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>
  73
  74 <span class="keyword">template</span><span class="special">&lt;</span>
  75     <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span>
  76     <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span>
  77     <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span>
  78     <span class="special">&gt;</span>
  79 <span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">&gt;::</span><span class="identifier">type</span>
  80 <span class="identifier">min_element</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</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>
  81 </pre>
  82 <p>
  83           </p>
  84 <h6>
  85 <a name="range.reference.algorithms.non_mutating.min_element.h1"></a>
  86             <span class="phrase"><a name="range.reference.algorithms.non_mutating.min_element.description"></a></span><a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.description">Description</a>
  87           </h6>
  88 <p>
  89             The versions of <code class="computeroutput"><span class="identifier">min_element</span></code>
  90             that return an iterator, return the iterator to the minimum value as
  91             determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code> if a predicate is not supplied. Otherwise
  92             the predicate <code class="computeroutput"><span class="identifier">pred</span></code> is
  93             used to determine the minimum value. The versions of <code class="computeroutput"><span class="identifier">min_element</span></code>
  94             that return a <code class="computeroutput"><span class="identifier">range_return</span></code>,
  95             defines <code class="computeroutput"><span class="identifier">found</span></code> in the
  96             same manner as the returned iterator described above.
  97           </p>
  98 <h6>
  99 <a name="range.reference.algorithms.non_mutating.min_element.h2"></a>
 100             <span class="phrase"><a name="range.reference.algorithms.non_mutating.min_element.definition"></a></span><a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.definition">Definition</a>
 101           </h6>
 102 <p>
 103             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">min_element</span><span class="special">.</span><span class="identifier">hpp</span></code>
 104           </p>
 105 <h6>
 106 <a name="range.reference.algorithms.non_mutating.min_element.h3"></a>
 107             <span class="phrase"><a name="range.reference.algorithms.non_mutating.min_element.requirements"></a></span><a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.requirements">Requirements</a>
 108           </h6>
 109 <p>
 110             <span class="bold"><strong>For the non-predicate versions:</strong></span>
 111           </p>
 112 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 113 <li class="listitem">
 114                 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a
 115                 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
 116                 Range</a> Concept.
 117               </li>
 118 <li class="listitem">
 119                 <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value
 120                 type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>.
 121               </li>
 122 </ul></div>
 123 <p>
 124             <span class="bold"><strong>For the predicate versions:</strong></span>
 125           </p>
 126 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 127 <li class="listitem">
 128                 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a
 129                 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
 130                 Range</a> Concept.
 131               </li>
 132 <li class="listitem">
 133                 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is
 134                 a model of the <code class="computeroutput"><span class="identifier">BinaryPredicateConcept</span></code>.
 135               </li>
 136 <li class="listitem">
 137                 <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value
 138                 type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
 139                 argument types.
 140               </li>
 141 </ul></div>
 142 <h6>
 143 <a name="range.reference.algorithms.non_mutating.min_element.h4"></a>
 144             <span class="phrase"><a name="range.reference.algorithms.non_mutating.min_element.complexity"></a></span><a class="link" href="min_element.html#range.reference.algorithms.non_mutating.min_element.complexity">Complexity</a>
 145           </h6>
 146 <p>
 147             Linear. Zero comparisons if <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>, otherwise <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code>
 148             comparisons.
 149           </p>
 150 </div>
 151 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 152 <td align="left"></td>
 153 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
 154       Neil Groves<p>
 155         Distributed under the Boost Software License, Version 1.0. (See accompanying
 156         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>)
 157       </p>
 158 </div></td>
 159 </tr></table>
 160 <hr>
 161 <div class="spirit-nav">
 162 <a accesskey="p" href="max_element.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="mismatch.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 163 </div>
 164 </body>
 165 </html>