]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/preprocessor/doc/ref/min.html
bump version to 12.2.2-pve1
[ceph.git] / ceph / src / boost / libs / preprocessor / doc / ref / min.html
CommitLineData
7c673cae
FG
1<html>
2<head>
3 <title>BOOST_PP_MIN</title>
4 <link rel="stylesheet" type="text/css" href="../styles.css">
5</head>
6<body>
7 <div style="margin-left: 0px;">
8 The <b>BOOST_PP_MIN</b> macro expands to the lesser of its two arguments.
9 </div>
10 <h4>Usage</h4>
11 <div class="code">
12 <b>BOOST_PP_MIN</b>(<i>x</i>, <i>y</i>)
13 </div>
14 <h4>Arguments</h4>
15 <dl>
16 <dt>x</dt>
17 <dd>
18 The first operand.&nbsp;
19 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
20 </dd>
21 <dt>y</dt>
22 <dd>
23 The second operand.&nbsp;
24 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
25 </dd>
26 </dl>
27 <h4>Remarks</h4>
28 <div>
29 This macro returns the lesser of its two arguments or the value of both arguments if they are equal.
30 </div>
31 <div>
32 Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>.&nbsp;
33 There is no longer any such restriction.&nbsp;
34 It is more efficient, however, to use <b>BOOST_PP_MIN_D</b> in such a situation.
35 </div>
36 <h4>See Also</h4>
37 <ul>
38 <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
39 <li><a href="min_d.html">BOOST_PP_MIN_D</a></li>
40 </ul>
41 <h4>Requirements</h4>
42 <div>
43 <b>Header:</b> &nbsp;<a href="../headers/selection/min.html">&lt;boost/preprocessor/selection/min.hpp&gt;</a>
44 </div>
45 <h4>Sample Code</h4>
46<div><pre>
47#include &lt;<a href="../headers/selection/min.html">boost/preprocessor/selection/min.hpp</a>&gt;
48
49<a href="min.html">BOOST_PP_MIN</a>(5, 7) // expands to 5
50<a href="min.html">BOOST_PP_MIN</a>(3, 3) // expands to 3
51</pre></div>
52 <hr size="1">
53 <div style="margin-left: 0px;">
54