ceph/src/boost/libs/mpl/doc/refmanual/max-element.html

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
   7 <title>The MPL Reference Manual: max_element</title>
   8 <link rel="stylesheet" href="../style.css" type="text/css" />
   9 </head>
  10 <body class="docframe refmanual">
  11 <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Prev</a>&nbsp;<a href="./equal.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Back</a>&nbsp;<a href="./equal.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./querying-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  12 <td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./querying-algorithms.html" class="navigation-link">Querying Algorithms</a> / <a href="./max-element.html" class="navigation-link">max_element</a></td>
  13 </tr></table><div class="header-separator"></div>
  14 <div class="section" id="max-element">
  15 <h1><a class="toc-backref" href="./querying-algorithms.html#id1483">max_element</a></h1>
  16 <div class="section" id="id599">
  17 <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18 <pre class="literal-block">
  19 template&lt;
  20       typename Sequence
  21     , typename Pred = <a href="./less.html" class="identifier">less</a>&lt;<a href="./placeholders.html" class="identifier">_1</a>,<a href="./placeholders.html" class="identifier">_2</a>&gt;
  22     &gt;
  23 struct <a href="./max-element.html" class="identifier">max_element</a>
  24 {
  25     typedef <em>unspecified</em> type;
  26 };
  27 </pre>
  28 </div>
  29 <div class="section" id="id600">
  30 <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  31 <p>Returns an iterator to the largest element in <tt class="literal"><span class="pre">Sequence</span></tt>.</p>
  32 </div>
  33 <div class="section" id="id601">
  34 <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  35 <pre class="literal-block">
  36 #include &lt;<a href="../../../../boost/mpl/max_element.hpp" class="header">boost/mpl/max_element.hpp</a>&gt;
  37 </pre>
  38 </div>
  39 <div class="section" id="id602">
  40 <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  41 <table border="1" class="docutils table">
  42 <colgroup>
  43 <col width="19%" />
  44 <col width="38%" />
  45 <col width="43%" />
  46 </colgroup>
  47 <thead valign="bottom">
  48 <tr><th class="head">Parameter</th>
  49 <th class="head">Requirement</th>
  50 <th class="head">Description</th>
  51 </tr>
  52 </thead>
  53 <tbody valign="top">
  54 <tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
  55 <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  56 <td>A sequence to be searched.</td>
  57 </tr>
  58 <tr><td><tt class="literal"><span class="pre">Pred</span></tt></td>
  59 <td>Binary <a class="reference internal" href="./lambda-expression.html">Lambda Expression</a></td>
  60 <td>A comparison criteria.</td>
  61 </tr>
  62 </tbody>
  63 </table>
  64 </div>
  65 <div class="section" id="id603">
  66 <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  67 <p>For any <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a> <tt class="literal"><span class="pre">s</span></tt> and binary <a class="reference internal" href="./lambda-expression.html">Lambda Expression</a> <tt class="literal"><span class="pre">pred</span></tt>:</p>
  68 <pre class="literal-block">
  69 typedef <a href="./max-element.html" class="identifier">max_element</a>&lt;s,pred&gt;::type i;
  70 </pre>
  71 <table class="docutils field-list" frame="void" rules="none">
  72 <col class="field-name" />
  73 <col class="field-body" />
  74 <tbody valign="top">
  75 <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="./forward-iterator.html">Forward Iterator</a>.</p>
  76 </td>
  77 </tr>
  78 <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">i</span></tt> is the first iterator in [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt>) such that for every iterator <tt class="literal"><span class="pre">j</span></tt>
  79 in [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt>),</p>
  80 <pre class="last literal-block">
  81 <a href="./apply.html" class="identifier">apply</a>&lt; pred, <a href="./deref.html" class="identifier">deref</a>&lt;i&gt;::type, <a href="./deref.html" class="identifier">deref</a>&lt;j&gt;::type &gt;::type::value == false
  82 </pre>
  83 </td>
  84 </tr>
  85 </tbody>
  86 </table>
  87 </div>
  88 <div class="section" id="id604">
  89 <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  90 <p>Linear. Zero comparisons if <tt class="literal"><span class="pre">s</span></tt> is empty, otherwise exactly <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">-</span> <span class="pre">1</span></tt>
  91 comparisons.</p>
  92 </div>
  93 <div class="section" id="id605">
  94 <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  95 <pre class="literal-block">
  96 typedef <a href="./vector.html" class="identifier">vector</a>&lt;bool,char[50],long,double&gt; types;
  97 typedef <a href="./max-element.html" class="identifier">max_element</a>&lt;
  98       <a href="./transform-view.html" class="identifier">transform_view</a>&lt; types,<a href="./sizeof.html" class="identifier">sizeof_</a>&lt;<a href="./placeholders.html" class="identifier">_1</a>&gt; &gt;
  99     &gt;::type iter;
 100
 101 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./deref.html" class="identifier">deref</a>&lt;iter::base&gt;::type, char[50]> ));
 102 </pre>
 103 </div>
 104 <div class="section" id="id606">
 105 <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
 106 <p><a class="reference internal" href="./querying-algorithms.html">Querying Algorithms</a>, <a class="reference internal" href="./min-element.html">min_element</a>, <a class="reference internal" href="./find-if.html">find_if</a>, <a class="reference internal" href="./upper-bound.html">upper_bound</a>, <a class="reference internal" href="./find.html">find</a></p>
 107 <!-- Algorithms/Querying Algorithms//equal |100 -->
 108 </div>
 109 </div>
 110
 111 <div class="footer-separator"></div>
 112 <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Prev</a>&nbsp;<a href="./equal.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Back</a>&nbsp;<a href="./equal.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./querying-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
 113 <td><div class="copyright-footer"><div class="copyright">Copyright ©  2001-2009 Aleksey Gurtovoy and David Abrahams</div>
 114 Distributed under the Boost Software License, Version 1.0. (See accompanying
 115 file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body>
 116 </html>