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

   1 <html>
   2 <head>
   3         <title>BOOST_PP_ITERATION_LIMITS</title>
   4         <link rel="stylesheet" type="text/css" href="../styles.css">
   5
   6 </head>
   7 <body>
   8         <div style="margin-left:  0px;">
   9                 The <b>BOOST_PP_ITERATION_LIMITS</b> macro is a user-defined <i>named external argument</i> used by <b>BOOST_PP_ITERATE</b>.&nbsp;
  10                 It denotes the lower and upper bounds of a <i>file-iteration</i>.
  11         </div>
  12         <h4>Usage</h4>
  13                 <div class="code">
  14                         #define <b>BOOST_PP_ITERATION_LIMITS</b> (<i>start</i>, <i>finish</i>)
  15                 </div>
  16         <h4>Arguments</h4>
  17                 <dl>
  18                         <dt>start</dt>
  19                         <dd>
  20                                 The lower bound (inclusive) of a <i>file-iteration</i>.&nbsp;
  21                                 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>.
  22                         </dd>
  23                         <dt>finish</dt>
  24                         <dd>
  25                                 The upper bound (inclusive) of a <i>file-iteration</i>.&nbsp;
  26                                 Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>.
  27                         </dd>
  28                 </dl>
  29         <h4>Remarks</h4>
  30                 <div>
  31                         Note that there is a whitespace character after the macro identifier.
  32                 </div>
  33                 <div>
  34                         This macro is part of the secondary method of passing arguments to <b>BOOST_PP_ITERATE</b>.&nbsp;
  35                         The other part is <b>BOOST_PP_FILENAME_<i>x</i></b>.&nbsp;Both <i>start</i> and <i>finish</i> are <i>evaluated parameters</i>.&nbsp;
  36                         This implies that they may include simple arithmetic.
  37                 </div>
  38                 <div>
  39                         This macro is automatically undefined for reuse by a call to <b>BOOST_PP_ITERATE</b>.
  40                 </div>
  41         <h4>See Also</h4>
  42                 <ul>
  43                         <li><a href="filename_x.html">BOOST_PP_FILENAME_<i>x</i></a></li>
  44                         <li><a href="iterate.html">BOOST_PP_ITERATE</a></li>
  45                         <li><a href="limit_iteration.html">BOOST_PP_LIMIT_ITERATION</a></li>
  46                 </ul>
  47         <hr size="1">
  48         <div style="margin-left: 0px;">
  49                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  50                 </br><i>© Copyright Paul Mensonides 2002</i>
  51         </div>
  52         <div style="margin-left: 0px;">
  53                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  54                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  55                 copy at <a href=
  56                 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  57         </div>
  58 </body>
  59 </html>