forked from boostorg/preprocessor
lib cleanup
[SVN r15693]
This commit is contained in:
53
doc/ref/max.html
Normal file
53
doc/ref/max.html
Normal file
@ -0,0 +1,53 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_MAX</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_MAX</b> macro expands to the greater of its two arguments.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_MAX</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 greater 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_MAX_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="max_d.html">BOOST_PP_MAX_D</a></li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/selection/max.hpp.html"><boost/preprocessor/selection/max.hpp></a>
|
||||
</div>
|
||||
<h4>Sample Code</h4>
|
||||
<div><pre>
|
||||
#include <<a href="../headers/selection/max.hpp.html">boost/preprocessor/selection/max.hpp</a>>
|
||||
|
||||
<a href="max.html">BOOST_PP_MAX</a>(5, 7) // expands to 7
|
||||
<a href="max.html">BOOST_PP_MAX</a>(3, 3) // expands to 3
|
||||
</pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user