Files
preprocessor/docs.1/ref/greater_equal_d.html
Paul Mensonides cdc4be5256 initial revision
[SVN r15198]
2002-09-08 09:40:56 +00:00

60 lines
1.9 KiB
HTML

<html>
<head>
<title>BOOST_PP_GREATER_EQUAL_D</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
<script language="javascript" type="text/javascript" src="../scripts.js"></script>
</head>
<body onload="init('sample');">
<div style="margin-left: 0px;">
The <b>BOOST_PP_GREATER_EQUAL_D</b> macro compares two values for equality or greater magnitude.&nbsp;
It reenters <b>BOOST_PP_WHILE</b> with maximum efficiency.
</div>
<h4>Usage</h4>
<div class="code">
<b>BOOST_PP_GREATER_EQUAL_D</b>(<i>d</i>, <i>x</i>, <i>y</i>)
</div>
<h4>Arguments</h4>
<dl>
<dt>d</dt>
<dd>
The next available <b>BOOST_PP_WHILE</b> iteration.&nbsp;
</dd>
<dt>x</dt>
<dd>
The left operand of the comparison.&nbsp;
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.&nbsp;
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>.&nbsp;
Otherwise, it expands to <i>0</i>.
</div>
<h4>See Also</h4>
<ul>
<li><a href="greater_equal.html">BOOST_PP_GREATER_EQUAL</a></li>
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
</ul>
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/comparison/greater_equal.hpp.html">&lt;boost/preprocessor/comparison/greater_equal.hpp&gt;</a>
</div>
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
<div id="sample"><pre>
#include &lt;boost/preprocessor/comparison/greater_equal.hpp&gt;
#include &lt;boost/preprocessor/list/filter.hpp&gt;
#define LIST (1, (2, (3, (4, (5, BOOST_PP_NIL)))))
#define PRED(d, _, num) BOOST_PP_GREATER_EQUAL_D(d, num, 4)
BOOST_PP_LIST_FILTER(PRED, nil, LIST) // expands to (4, (5, BOOST_PP_NIL))
<pre></div>
</body>
</html>