repeat_from_to_d_z.html 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <html>
  2. <head>
  3. <title>BOOST_PP_REPEAT_FROM_TO_D_z</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_REPEAT_FROM_TO_D_<i>z</i></b> macro represents a fast horizontal repetition construct.&nbsp;
  9. It reenters both <b>BOOST_PP_REPEAT</b> and <b>BOOST_PP_WHILE</b> with maximum efficiency.
  10. </div>
  11. <h4>Usage</h4>
  12. <div class="code">
  13. <b>BOOST_PP_REPEAT_FROM_TO_D_<i>z</i></b>(<i>d</i>, <i>first</i>, <i>last</i>, <i>macro</i>, <i>data</i>)
  14. </div>
  15. <h4>Arguments</h4>
  16. <dl>
  17. <dt>z</dt>
  18. <dd>
  19. The next available <b>BOOST_PP_REPEAT</b> dimension.
  20. </dd>
  21. <dt>d</dt>
  22. <dd>
  23. The next available <b>BOOST_PP_WHILE</b> iteration.
  24. </dd>
  25. <dt>first</dt>
  26. <dd>
  27. The lower bound of the repetition.&nbsp;
  28. Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
  29. </dd>
  30. <dt>last</dt>
  31. <dd>
  32. The upper bound of the repetition.
  33. Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
  34. </dd>
  35. <dt>macro</dt>
  36. <dd>
  37. A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>).&nbsp;
  38. This macro is expanded by <b>BOOST_PP_REPEAT</b> with the next available repetition depth,
  39. the current repetition number, and the auxiliary <i>data</i> argument.&nbsp;
  40. </dd>
  41. <dt>data</dt>
  42. <dd>
  43. Auxiliary data passed to <i>macro</i>.
  44. </dd>
  45. </dl>
  46. <h4>Remarks</h4>
  47. <div>
  48. This macro expands to the sequence:
  49. <div>
  50. <i>macro</i>(<i>z</i>, <i>first</i>, <i>data</i>) <i>macro</i>(<i>z</i>, <i>first</i> + <i>1</i>, <i>data</i>) ... <i>macro</i>(<i>z</i>, <i>last</i> - <i>1</i>, <i>data</i>)
  51. </div>
  52. </div>
  53. <div>
  54. The number of repetitions (i.e. <i>last</i> - <i>first</i>) must not exceed <b>BOOST_PP_LIMIT_REPEAT</b>.
  55. </div>
  56. <div>
  57. The <i>z</i> value that is passed to <i>macro</i> represents the next available repetition dimension.&nbsp;
  58. Other macros that have <b>_Z</b> suffix variants internally use <b>BOOST_PP_REPEAT</b>--for example, <b>BOOST_PP_ENUM_PARAMS</b> and <b>BOOST_PP_ENUM_PARAMS_Z</b>.&nbsp;
  59. Using these <b>_Z</b> versions is not strictly necessary, but passing the <i>z</i> value (that is passed to <i>macro</i>) to these macros allows them to reenter <b>BOOST_PP_REPEAT</b> with maximum efficiency.
  60. </div>
  61. <h4>See Also</h4>
  62. <ul>
  63. <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
  64. <li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
  65. <li><a href="repeat_from_to.html">BOOST_PP_REPEAT_FROM_TO</a></li>
  66. <li><a href="repeat_from_to_d.html">BOOST_PP_REPEAT_FROM_TO_D</a></li>
  67. </ul>
  68. <h4>Requirements</h4>
  69. <div>
  70. <b>Header:</b> &nbsp;<a href="../headers/repetition/repeat_from_to.html">&lt;boost/preprocessor/repetition/repeat_from_to.hpp&gt;</a>
  71. </div>
  72. <hr size="1">
  73. <div style="margin-left: 0px;">
  74. <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  75. </br><i>© Copyright Paul Mensonides 2002</i>
  76. </div>
  77. <div style="margin-left: 0px;">
  78. <p><small>Distributed under the Boost Software License, Version 1.0. (See
  79. accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  80. copy at <a href=
  81. "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  82. </div>
  83. </body>
  84. </html>