64 lines
2.0 KiB
HTML
64 lines
2.0 KiB
HTML
<html>
|
|
<head>
|
|
<title>BOOST_PP_MOD</title>
|
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
|
</head>
|
|
<body>
|
|
<div style="margin-left: 0px;">
|
|
The <b>BOOST_PP_MOD</b> macro expands to the modulus of its arguments.
|
|
</div>
|
|
<h4>Usage</h4>
|
|
<div class="code">
|
|
<b>BOOST_PP_MOD</b>(<i>x</i>, <i>y</i>)
|
|
</div>
|
|
<h4>Arguments</h4>
|
|
<dl>
|
|
<dt>x</dt>
|
|
<dd>
|
|
The dividend (numerator) of the operation.
|
|
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.
|
|
Valid values range from <i>1</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
|
</dd>
|
|
</dl>
|
|
<h4>Remarks</h4>
|
|
<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_MOD_D</b> in such a situation.
|
|
</div>
|
|
<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_d.html">BOOST_PP_MOD_D</a></li>
|
|
</ul>
|
|
<h4>Requirements</h4>
|
|
<div>
|
|
<b>Header:</b> <a href="../headers/arithmetic/mod.html"><boost/preprocessor/arithmetic/mod.hpp></a>
|
|
</div>
|
|
<h4>Sample Code</h4>
|
|
<div><pre>
|
|
#include <<a href="../headers/arithmetic/mod.html">boost/preprocessor/arithmetic/mod.hpp</a>>
|
|
|
|
<a href="mod.html">BOOST_PP_MOD</a>(11, 5) // expands to 1
|
|
</pre></div>
|
|
<hr size="1">
|
|
<div style="margin-left: 0px;">
|
|
<i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
|
|
</br><i>© Copyright Paul Mensonides 2002</i>
|
|
</div>
|
|
<div style="margin-left: 0px;">
|
|
<p><small>Distributed under the Boost Software License, Version 1.0. (See
|
|
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
|
|
copy at <a href=
|
|
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
|
|
</div>
|
|
</body>
|
|
</html>
|