Sha256: 6d4ff641e09047dd9698ef917c449cd67411ea0622f11f024440c8fe21d39fd4

Contents?: true

Size: 1.96 KB

Versions: 10

Compression:

Stored size: 1.96 KB

Contents

<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.&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>
			Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>.&nbsp;
			There is no longer any such restriction.&nbsp;
			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> &nbsp;<a href="../headers/arithmetic/mod.html">&lt;boost/preprocessor/arithmetic/mod.hpp&gt;</a>
		</div>
	<h4>Sample Code</h4>
<div><pre>
#include &lt;<a href="../headers/arithmetic/mod.html">boost/preprocessor/arithmetic/mod.hpp</a>&gt;

<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>

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
script_core-0.3.2 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.2.1 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.2.0 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.1.1 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.1.0 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.0.5 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.0.4 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.0.3 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.0.2 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html
script_core-0.0.1 ext/enterprise_script_service/msgpack/external/boost/preprocessor/doc/ref/mod.html