mirror of
https://github.com/boostorg/preprocessor.git
synced 2025-07-05 00:36:31 +02:00
54 lines
1.5 KiB
HTML
54 lines
1.5 KiB
HTML
<html>
|
|
<head>
|
|
<title>BOOST_PP_MIN</title>
|
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
|
</head>
|
|
<body>
|
|
<div style="margin-left: 0px;">
|
|
The <b>BOOST_PP_MIN</b> macro expands to the lesser of its two arguments.
|
|
</div>
|
|
<h4>Usage</h4>
|
|
<div class="code">
|
|
<b>BOOST_PP_MIN</b>(<i>x</i>, <i>y</i>)
|
|
</div>
|
|
<h4>Arguments</h4>
|
|
<dl>
|
|
<dt>x</dt>
|
|
<dd>
|
|
The first operand.
|
|
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
|
</dd>
|
|
<dt>y</dt>
|
|
<dd>
|
|
The second operand.
|
|
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
|
</dd>
|
|
</dl>
|
|
<h4>Remarks</h4>
|
|
<div>
|
|
This macro returns the lesser of its two arguments or the value of both arguments if they are equal.
|
|
</div>
|
|
<div>
|
|
Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>.
|
|
There is no longer any such restriction.
|
|
It is more efficient, however, to use <b>BOOST_PP_MIN_D</b> in such a situation.
|
|
</div>
|
|
<h4>See Also</h4>
|
|
<ul>
|
|
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
|
|
<li><a href="min_d.html">BOOST_PP_MIN_D</a></li>
|
|
</ul>
|
|
<h4>Requirements</h4>
|
|
<div>
|
|
<b>Header:</b> <a href="../headers/selection/min.hpp.html"><boost/preprocessor/selection/min.hpp></a>
|
|
</div>
|
|
<h4>Sample Code</h4>
|
|
<div><pre>
|
|
#include <<a href="../headers/selection/min.hpp.html">boost/preprocessor/selection/min.hpp</a>>
|
|
|
|
<a href="min.html">BOOST_PP_MIN</a>(5, 7) // expands to 5
|
|
<a href="min.html">BOOST_PP_MIN</a>(3, 3) // expands to 3
|
|
</pre></div>
|
|
</body>
|
|
</html>
|