1<html> 2<head> 3 <title>BOOST_PP_MOD</title> 4 <link rel="stylesheet" type="text/css" href="../styles.css"> 5</head> 6<body> 7 <div style="margin-left: 0px;"> 8 The <b>BOOST_PP_MOD</b> macro expands to the modulus of its arguments. 9 </div> 10 <h4>Usage</h4> 11 <div class="code"> 12 <b>BOOST_PP_MOD</b>(<i>x</i>, <i>y</i>) 13 </div> 14 <h4>Arguments</h4> 15 <dl> 16 <dt>x</dt> 17 <dd> 18 The dividend (numerator) of the operation. 19 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>. 20 </dd> 21 <dt>y</dt> 22 <dd> 23 The divisor (denominator) of the operation. 24 Valid values range from <i>1</i> to <b>BOOST_PP_LIMIT_MAG</b>. 25 </dd> 26 </dl> 27 <h4>Remarks</h4> 28 <div> 29 Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>. 30 There is no longer any such restriction. 31 It is more efficient, however, to use <b>BOOST_PP_MOD_D</b> in such a situation. 32 </div> 33 <div> 34 If <i>y</i> is <i>0</i>, the result is undefined. 35 </div> 36 <h4>See Also</h4> 37 <ul> 38 <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li> 39 <li><a href="mod_d.html">BOOST_PP_MOD_D</a></li> 40 </ul> 41 <h4>Requirements</h4> 42 <div> 43 <b>Header:</b> <a href="../headers/arithmetic/mod.html"><boost/preprocessor/arithmetic/mod.hpp></a> 44 </div> 45 <h4>Sample Code</h4> 46<div><pre> 47#include <<a href="../headers/arithmetic/mod.html">boost/preprocessor/arithmetic/mod.hpp</a>> 48 49<a href="mod.html">BOOST_PP_MOD</a>(11, 5) // expands to 1 50</pre></div> 51 <hr size="1"> 52 <div style="margin-left: 0px;"> 53 <i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i> 54 </br><i>� Copyright Paul Mensonides 2002</i> 55 </div> 56 <div style="margin-left: 0px;"> 57 <p><small>Distributed under the Boost Software License, Version 1.0. (See 58 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or 59 copy at <a href= 60 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> 61 </div> 62</body> 63</html> 64