Files
boost_preprocessor/docs.1/ref/mod_d.html

67 lines
2.0 KiB
HTML
Raw Normal View History

2002-09-08 09:40:56 +00:00
<html>
<head>
<title>BOOST_PP_MOD_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_MOD_D</b> macro expands to the modulus of its second and third arguments.&nbsp;
It reenters <b>BOOST_PP_WHILE</b> with maximum efficiency.
</div>
<h4>Usage</h4>
<div class="code">
<b>BOOST_PP_MOD_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 dividend (numerator) of the operation.&nbsp;
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
</dd>
<dt>y</dt>
<dd>
The divisor (denominator) of the operation.&nbsp;
Valid values range from <i>1</i> to <b>BOOST_PP_LIMIT_MAG</b>.
</dd>
</dl>
<h4>Remarks</h4>
<div>
If <i>y</i> is <i>0</i>, the result is undefined.
</div>
<h4>See Also</h4>
<ul>
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
<li><a href="mod.html">BOOST_PP_MOD</a></li>
</ul>
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/arithmetic/div.hpp.html">&lt;boost/preprocessor/arithmetic/div.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/arithmetic/mod.hpp&gt;
#include &lt;boost/preprocessor/list/filter.hpp&gt;
#include &lt;boost/preprocessor/logical/not.hpp&gt;
#define LIST (1, (2, (3, (4, (5, BOOST_PP_NIL)))))
#define EVEN_P(d, _, num) BOOST_PP_NOT(BOOST_PP_MOD_D(d, num, 2))
#define EVEN(list) BOOST_PP_LIST_FILTER(EVEN_P, nil, list)
EVEN(LIST) // expands to (2, (4, BOOST_PP_NIL))
#define ODD_P(d, _, num) BOOST_PP_MOD_D(d, num, 2)
#define ODD(list) BOOST_PP_LIST_FILTER(ODD_P, nil, list)
ODD(LIST) // expands to (1, (3, (5, BOOST_PP_NIL)))
<pre></div>
</body>
</html>