Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/min.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 7.2 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<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: min</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./numeric-cast.html" class="navigation-link">Prev</a>&nbsp;<a href="./max.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./numeric-cast.html" class="navigation-link">Back</a>&nbsp;<a href="./max.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>
15<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="./min.html" class="navigation-link">min</a></td>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="min">
18<h1><a class="toc-backref" href="./miscellaneous.html#id493" name="min">min</a></h1>
19<div class="section" id="miscellaneous-min-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt;
23      typename N1
24    , typename N2
25    &gt;
26struct <a href="./min.html" class="identifier">min</a>
27{
28    typedef <em>unspecified</em> type;
29};
30</pre>
31</div>
32<div class="section" id="miscellaneous-min-description">
33<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
34<p>Returns the smaller of its two arguments.</p>
35</div>
36<div class="section" id="miscellaneous-min-header">
37<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
38<pre class="literal-block">
39#include &lt;<a href="../../../../boost/mpl/min_max.hpp" class="header">boost/mpl/min_max.hpp</a>&gt;
40</pre>
41</div>
42<div class="section" id="min-model-of">
43<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
44<p><a class="reference" href="./metafunction.html">Metafunction</a></p>
45</div>
46<div class="section" id="miscellaneous-min-parameters">
47<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
48<table border="1" class="table">
49<colgroup>
50<col width="19%" />
51<col width="25%" />
52<col width="56%" />
53</colgroup>
54<thead valign="bottom">
55<tr><th>Parameter</th>
56<th>Requirement</th>
57<th>Description</th>
58</tr>
59</thead>
60<tbody valign="top">
61<tr><td><tt class="literal"><span class="pre">N1</span></tt>, <tt class="literal"><span class="pre">N2</span></tt></td>
62<td>Any type</td>
63<td>Types to compare.</td>
64</tr>
65</tbody>
66</table>
67</div>
68<div class="section" id="miscellaneous-min-expression-semantics">
69<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
70<p>For arbitrary types <tt class="literal"><span class="pre">x</span></tt> and <tt class="literal"><span class="pre">y</span></tt>:</p>
71<pre class="literal-block">
72typedef <a href="./min.html" class="identifier">min</a>&lt;x,y&gt;::type r;
73</pre>
74<table class="field-list" frame="void" rules="none">
75<col class="field-name" />
76<col class="field-body" />
77<tbody valign="top">
78<tr class="field"><th class="field-name">Return type:</th><td class="field-body">A type.</td>
79</tr>
80<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>
81</tr>
82<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
83<pre class="last literal-block">
84typedef <a href="./if.html" class="identifier">if_</a>&lt; <a href="./less.html" class="identifier">less</a>&lt;x,y&gt;,x,y &gt;::type r;
85</pre>
86</td>
87</tr>
88</tbody>
89</table>
90</div>
91<div class="section" id="miscellaneous-min-complexity">
92<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
93<p>Constant time.</p>
94</div>
95<div class="section" id="miscellaneous-min-example">
96<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
97<pre class="literal-block">
98typedef <a href="./fold.html" class="identifier">fold</a>&lt;
99      <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,1,7,0,-2,5,-1&gt;
100    , <a href="./int.html" class="identifier">int_</a>&lt;-10&gt;
101    , <a href="./min.html" class="identifier">min</a>&lt;_1,_2&gt;
102    &gt;::type r;
103
104<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; > ));
105</pre>
106</div>
107<div class="section" id="miscellaneous-min-see-also">
108<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
109<p><a class="reference" href="./metafunctions.html">Metafunctions</a>, <a class="reference" href="./comparisons.html">comparison</a>, <a class="refentry reference" href="./max.html"><tt class="refentry literal"><span class="pre">max</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="./min-element.html"><tt class="refentry literal"><span class="pre">min_element</span></tt></a></p>
110<!-- modtime: November 11, 2004 10:24:49 +0000 -->
111<!-- Metafunctions/Miscellaneous//max |90 -->
112</div>
113</div>
114
115<div class="footer-separator"></div>
116<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./numeric-cast.html" class="navigation-link">Prev</a>&nbsp;<a href="./max.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./numeric-cast.html" class="navigation-link">Back</a>&nbsp;<a href="./max.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>
117</tr></table></body>
118</html>
Note: See TracBrowser for help on using the repository browser.