ceph/src/boost/libs/preprocessor/doc/ref/mod_d.html

   1 <html>
   2 <head>
   3         <title>BOOST_PP_MOD_D</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_D</b> macro expands to the modulus of its second and third arguments.&nbsp;
   9                 It reenters <b>BOOST_PP_WHILE</b> with maximum efficiency.
  10         </div>
  11         <h4>Usage</h4>
  12                 <div class="code">
  13                         <b>BOOST_PP_MOD_D</b>(<i>d</i>, <i>x</i>, <i>y</i>)
  14                 </div>
  15         <h4>Arguments</h4>
  16                 <dl>
  17                         <dt>d</dt>
  18                         <dd>
  19                                 The next available <b>BOOST_PP_WHILE</b> iteration.&nbsp;
  20                         </dd>
  21                         <dt>x</dt>
  22                         <dd>
  23                                 The dividend (numerator) of the operation.&nbsp;
  24                                 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
  25                         </dd>
  26                         <dt>y</dt>
  27                         <dd>
  28                                 The divisor (denominator) of the operation.&nbsp;
  29                                 Valid values range from <i>1</i> to <b>BOOST_PP_LIMIT_MAG</b>.
  30                         </dd>
  31                 </dl>
  32         <h4>Remarks</h4>
  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.html">BOOST_PP_MOD</a></li>
  40                 </ul>
  41         <h4>Requirements</h4>
  42                 <div>
  43                         <b>Header:</b> &nbsp;<a href="../headers/arithmetic/div.html">&lt;boost/preprocessor/arithmetic/div.hpp&gt;</a>
  44                 </div>
  45         <h4>Sample Code</h4>
  46 <div><pre>
  47 #include &lt;<a href="../headers/arithmetic/mod.html">boost/preprocessor/arithmetic/mod.hpp</a>&gt;
  48 #include &lt;<a href="../headers/list/filter.html">boost/preprocessor/list/filter.hpp</a>&gt;
  49 #include &lt;<a href="../headers/logical/not.html">boost/preprocessor/logical/not.hpp</a>&gt;
  50
  51 #define LIST (1, (2, (3, (4, (5, <a href="nil.html">BOOST_PP_NIL</a>)))))
  52
  53 #define EVEN_P(d, _, num) <a href="not.html">BOOST_PP_NOT</a>(<a href="mod_d.html">BOOST_PP_MOD_D</a>(d, num, 2))
  54 #define EVEN(list) <a href="list_filter.html">BOOST_PP_LIST_FILTER</a>(EVEN_P, nil, list)
  55
  56 EVEN(LIST) // expands to (2, (4, <a href="nil.html">BOOST_PP_NIL</a>))
  57
  58 #define ODD_P(d, _, num) <a href="mod_d.html">BOOST_PP_MOD_D</a>(d, num, 2)
  59 #define ODD(list) <a href="list_filter.html">BOOST_PP_LIST_FILTER</a>(ODD_P, nil, list)
  60
  61 ODD(LIST) // expands to (1, (3, (5, <a href="nil.html">BOOST_PP_NIL</a>)))
  62 </pre></div>
  63         <hr size="1">
  64         <div style="margin-left: 0px;">
  65                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  66                 </br><i>© Copyright Paul Mensonides 2002</i>
  67         </div>
  68         <div style="margin-left: 0px;">
  69                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  70                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  71                 copy at <a href=
  72                 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  73         </div>
  74 </body>
  75 </html>