forked from boostorg/preprocessor
lib cleanup
[SVN r15693]
This commit is contained in:
54
doc/ref/greater_equal.html
Normal file
54
doc/ref/greater_equal.html
Normal file
@ -0,0 +1,54 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_GREATER_EQUAL</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_GREATER_EQUAL</b> macro compares two values for equality or greater magnitude.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_GREATER_EQUAL</b>(<i>x</i>, <i>y</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>x</dt>
|
||||
<dd>
|
||||
The left operand of the comparison.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
||||
</dd>
|
||||
<dt>y</dt>
|
||||
<dd>
|
||||
The right operand of the comparison.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
If <i>x</i> is greater than or equal to <i>y</i>, this macro expands to <i>1</i>.
|
||||
Otherwise, it expands to <i>0</i>.
|
||||
</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_GREATER_EQUAL_D</b> in such a situation.
|
||||
</div>
|
||||
<h4>See Also</h4>
|
||||
<ul>
|
||||
<li><a href="greater_equal_d.html">BOOST_PP_GREATER_EQUAL_D</a></li>
|
||||
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/comparison/greater_equal.hpp.html"><boost/preprocessor/comparison/greater_equal.hpp></a>
|
||||
</div>
|
||||
<h4>Sample Code</h4>
|
||||
<div><pre>
|
||||
#include <<a href="../headers/comparison/greater_equal.hpp.html">boost/preprocessor/comparison/greater_equal.hpp</a>>
|
||||
|
||||
<a href="greater_equal.html">BOOST_PP_GREATER_EQUAL</a>(4, 3) // expands to 1
|
||||
<a href="greater_equal.html">BOOST_PP_GREATER_EQUAL</a>(5, 5) // expands to 1
|
||||
</pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user