Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/max.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
File size: 7.0 KB
Line 
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.3.6: 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#id494" name="max">max</a></h1>
16<div class="section" id="miscellaneous-max-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt;
20      typename N1
21    , typename N2
22    &gt;
23struct <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="miscellaneous-max-description">
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="miscellaneous-max-header">
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="max-model-of">
40<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
41<p><a class="reference" href="./metafunction.html">Metafunction</a></p>
42</div>
43<div class="section" id="miscellaneous-max-parameters">
44<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
45<table border="1" class="table">
46<colgroup>
47<col width="19%" />
48<col width="25%" />
49<col width="56%" />
50</colgroup>
51<thead valign="bottom">
52<tr><th>Parameter</th>
53<th>Requirement</th>
54<th>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="miscellaneous-max-expression-semantics">
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">
69typedef <a href="./max.html" class="identifier">max</a>&lt;x,y&gt;::type r;
70</pre>
71<table class="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">A type.</td>
76</tr>
77<tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><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.</td>
78</tr>
79<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
80<pre class="last literal-block">
81typedef <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;
82</pre>
83</td>
84</tr>
85</tbody>
86</table>
87</div>
88<div class="section" id="miscellaneous-max-complexity">
89<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
90<p>Constant time.</p>
91</div>
92<div class="section" id="miscellaneous-max-example">
93<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
94<pre class="literal-block">
95typedef <a href="./fold.html" class="identifier">fold</a>&lt;
96      <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,1,7,0,-2,5,-1&gt;
97    , <a href="./int.html" class="identifier">int_</a>&lt;10&gt;
98    , <a href="./max.html" class="identifier">max</a>&lt;_1,_2&gt;
99    &gt;::type r;
100
101<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; > ));
102</pre>
103</div>
104<div class="section" id="miscellaneous-max-see-also">
105<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
106<p><a class="reference" href="./metafunctions.html">Metafunctions</a>, <a class="reference" href="./comparisons.html">comparison</a>, <a class="refentry reference" href="./min.html"><tt class="refentry literal"><span class="pre">min</span></tt></a>, <a class="refentry reference" href="./less.html"><tt class="refentry literal"><span class="pre">less</span></tt></a>, <a class="refentry reference" href="./max-element.html"><tt class="refentry literal"><span class="pre">max_element</span></tt></a></p>
107<!-- modtime: November 11, 2004 10:24:55 +0000 -->
108<!-- Metafunctions/Miscellaneous//sizeof_ |100 -->
109</div>
110</div>
111
112<div class="footer-separator"></div>
113<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>
114</tr></table></body>
115</html>
Note: See TracBrowser for help on using the repository browser.