enum_binary_params.html 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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_BINARY_PARAMS</b> macro generates a comma-separated list of binary parameters.
  9. </div>
  10. <h4>Usage</h4>
  11. <div class="code">
  12. <b>BOOST_PP_ENUM_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_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_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>0</i> <i>p2</i> ## <i>0</i>, <i>p1</i> ## <i>1</i> <i>p2</i> ## <i>1</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_BINARY_PARAMS_Z</b>.
  43. </div>
  44. <div>
  45. This macro is a replacement for both <b>BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT</b> and <b>BOOST_PP_ENUM_PARAMS_WITH_DEFAULTS</b>.
  46. </div>
  47. <h4>See Also</h4>
  48. <ul>
  49. <li><a href="enum_binary_params_z.html">BOOST_PP_ENUM_BINARY_PARAMS_Z</a></li>
  50. <li><a href="enum_params_with_a_default.html">BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT</a></li>
  51. <li><a href="enum_params_with_defaults.html">BOOST_PP_ENUM_PARAMS_WITH_DEFAULTS</a></li>
  52. <li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
  53. </ul>
  54. <h4>Requirements</h4>
  55. <div>
  56. <b>Header:</b> &nbsp;<a href="../headers/repetition/enum_binary_params.html">&lt;boost/preprocessor/repetition/enum_binary_params.hpp&gt;</a>
  57. </div>
  58. <h4>Sample Code</h4>
  59. <div><pre>
  60. #include &lt;<a href="../headers/repetition/enum_binary_params.html">boost/preprocessor/repetition/enum_binary_params.hpp</a>&gt;
  61. <a href="enum_binary_params.html">BOOST_PP_ENUM_BINARY_PARAMS</a>(3, T, p) // expands to T0 p0, T1 p1, T2 p2
  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>