esbp.html 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. <html>
  2. <head>
  3. <title>BOOST_PP_ENUM_BINARY_PARAMS</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_ENUM_SHIFTED_BINARY_PARAMS</b> macro generates a comma-separated, shifted list of binary parameters.
  9. </div>
  10. <h4>Usage</h4>
  11. <div class="code">
  12. <b>BOOST_PP_ENUM_SHIFTED_BINARY_PARAMS</b>(<i>count</i>, <i>p1</i>, <i>p2</i>)
  13. </div>
  14. <h4>Arguments</h4>
  15. <dl>
  16. <dt>count</dt>
  17. <dd>
  18. The number of parameters to generate.&nbsp;
  19. Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>.
  20. </dd>
  21. <dt>p1</dt>
  22. <dd>
  23. The text of the first part of the parameter.&nbsp;
  24. <b>BOOST_PP_ENUM_SHIFTED_BINARY_PARAMS</b> concatenates numbers ranging from <i>0</i> to <i>count</i> - <i>1</i>
  25. to generate parameters.
  26. </dd>
  27. <dt>p2</dt>
  28. <dd>
  29. The text of the first part of the parameter.&nbsp;
  30. <b>BOOST_PP_ENUM_SHIFTED_BINARY_PARAMS</b> concatenates numbers ranging from <i>0</i> to <i>count</i> - <i>1</i>
  31. to generate parameters.
  32. </dd>
  33. </dl>
  34. <h4>Remarks</h4>
  35. <div>
  36. This macro expands to the comma-separated sequence:
  37. <div>
  38. <i>p1</i> ## <i>1</i> <i>p2</i> ## <i>1</i>, <i>p1</i> ## <i>2</i> <i>p2</i> ## <i>2</i>, ... <i>p1</i> ## <i>count</i> - <i>1</i> <i>p2</i> ## <i>count</i> - <i>1</i>
  39. </div>
  40. </div>
  41. <div>
  42. To use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>, see <b>BOOST_PP_ENUM_SHIFTED_BINARY_PARAMS_Z</b>.
  43. </div>
  44. <h4>See Also</h4>
  45. <ul>
  46. <li><a href="esbpz.html">BOOST_PP_ENUM_SHIFTED_BINARY_PARAMS_Z</a></li>
  47. <li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
  48. </ul>
  49. <h4>Requirements</h4>
  50. <div>
  51. <b>Header:</b> &nbsp;<a href="../headers/repetition/esbp.html">&lt;boost/preprocessor/repetition/enum_shifted_binary_params.hpp&gt;</a>
  52. </div>
  53. <hr size="1">
  54. <div style="margin-left: 0px;">
  55. <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  56. </br><i>© Copyright Paul Mensonides 2002</i>
  57. </div>
  58. <div style="margin-left: 0px;">
  59. <p><small>Distributed under the Boost Software License, Version 1.0. (See
  60. accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  61. copy at <a href=
  62. "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  63. </div>
  64. </body>
  65. </html>