ceph/src/boost/libs/mpl/doc/refmanual/max.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</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.html" class="navigation-link">Prev</a>&nbsp;<a href="./sizeof.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./min.html" class="navigation-link">Back</a>&nbsp;<a href="./sizeof.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./miscellaneous.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="./metafunctions.html" class="navigation-link">Metafunctions</a> / <a href="./miscellaneous.html" class="navigation-link">Miscellaneous</a> / <a href="./max.html" class="navigation-link">max</a></td>
  13 </tr></table><div class="header-separator"></div>
  14 <div class="section" id="max">
  15 <h1><a class="toc-backref" href="./miscellaneous.html#id1570">max</a></h1>
  16 <div class="section" id="id1198">
  17 <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18 <pre class="literal-block">
  19 template&lt;
  20       typename N1
  21     , typename N2
  22     &gt;
  23 struct <a href="./max.html" class="identifier">max</a>
  24 {
  25     typedef <em>unspecified</em> type;
  26 };
  27 </pre>
  28 </div>
  29 <div class="section" id="id1199">
  30 <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  31 <p>Returns the larger of its two arguments.</p>
  32 </div>
  33 <div class="section" id="id1200">
  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/min_max.hpp" class="header">boost/mpl/min_max.hpp</a>&gt;
  37 </pre>
  38 </div>
  39 <div class="section" id="id1201">
  40 <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  41 <p><a class="reference internal" href="./metafunction.html">Metafunction</a></p>
  42 </div>
  43 <div class="section" id="id1202">
  44 <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  45 <table border="1" class="docutils table">
  46 <colgroup>
  47 <col width="19%" />
  48 <col width="25%" />
  49 <col width="56%" />
  50 </colgroup>
  51 <thead valign="bottom">
  52 <tr><th class="head">Parameter</th>
  53 <th class="head">Requirement</th>
  54 <th class="head">Description</th>
  55 </tr>
  56 </thead>
  57 <tbody valign="top">
  58 <tr><td><tt class="literal"><span class="pre">N1</span></tt>, <tt class="literal"><span class="pre">N2</span></tt></td>
  59 <td>Any type</td>
  60 <td>Types to compare.</td>
  61 </tr>
  62 </tbody>
  63 </table>
  64 </div>
  65 <div class="section" id="id1203">
  66 <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  67 <p>For arbitrary types <tt class="literal"><span class="pre">x</span></tt> and <tt class="literal"><span class="pre">y</span></tt>:</p>
  68 <pre class="literal-block">
  69 typedef <a href="./max.html" class="identifier">max</a>&lt;x,y&gt;::type r;
  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 type.</p>
  76 </td>
  77 </tr>
  78 <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre"><a href="./less.html" class="identifier">less</a>&lt;x,y&gt;::value</span></tt> is a well-formed integral constant expression.</p>
  79 </td>
  80 </tr>
  81 <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
  82 <pre class="last literal-block">
  83 typedef <a href="./if.html" class="identifier">if_</a>&lt; <a href="./less.html" class="identifier">less</a>&lt;x,y&gt;,y,x &gt;::type r;
  84 </pre>
  85 </td>
  86 </tr>
  87 </tbody>
  88 </table>
  89 </div>
  90 <div class="section" id="id1204">
  91 <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  92 <p>Constant time.</p>
  93 </div>
  94 <div class="section" id="id1205">
  95 <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  96 <pre class="literal-block">
  97 typedef <a href="./fold.html" class="identifier">fold</a>&lt;
  98       <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,1,7,0,-2,5,-1&gt;
  99     , <a href="./int.html" class="identifier">int_</a>&lt;10&gt;
 100     , <a href="./max.html" class="identifier">max</a>&lt;<a href="./placeholders.html" class="identifier">_1</a>,<a href="./placeholders.html" class="identifier">_2</a>&gt;
 101     &gt;::type r;
 102
 103 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; r, <a href="./int.html" class="identifier">int_</a>&lt;10&gt; > ));
 104 </pre>
 105 </div>
 106 <div class="section" id="id1206">
 107 <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
 108 <p><a class="reference internal" href="./metafunctions.html">Metafunctions</a>, <a class="reference internal" href="./comparisons.html">comparison</a>, <a class="reference internal" href="./min.html">min</a>, <a class="reference internal" href="./less.html">less</a>, <a class="reference internal" href="./max-element.html">max_element</a></p>
 109 <!-- Metafunctions/Miscellaneous//sizeof_ |100 -->
 110 </div>
 111 </div>
 112
 113 <div class="footer-separator"></div>
 114 <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./min.html" class="navigation-link">Prev</a>&nbsp;<a href="./sizeof.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./min.html" class="navigation-link">Back</a>&nbsp;<a href="./sizeof.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./miscellaneous.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>
 115 <td><div class="copyright-footer"><div class="copyright">Copyright ©  2001-2009 Aleksey Gurtovoy and David Abrahams</div>
 116 Distributed under the Boost Software License, Version 1.0. (See accompanying
 117 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>
 118 </html>