array_insert_d.html 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <html>
  2. <head>
  3. <title>BOOST_PP_ARRAY_INSERT_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_ARRAY_INSERT_D</b> macro inserts an element into an <i>array</i>.&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_ARRAY_INSERT_D</b>(<i>d</i>, <i>array</i>, <i>i</i>, <i>elem</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.
  20. </dd>
  21. <dt>array</dt>
  22. <dd>
  23. The <i>array</i> into which an element is to be inserted.
  24. </dd>
  25. <dt>i</dt>
  26. <dd>
  27. The zero-based position in <i>array</i> where an element is to be inserted.&nbsp;
  28. Valid values range from <i>0</i> to <b>BOOST_PP_ARRAY_SIZE</b>(<i>array</i>).
  29. </dd>
  30. <dt>elem</dt>
  31. <dd>
  32. The element to insert.
  33. </dd>
  34. </dl>
  35. <h4>Remarks</h4>
  36. <div>
  37. This macro inserts <i>elem</i> before the element at index <i>i</i>.
  38. </div>
  39. <div>
  40. If the operation attempts to create an <i>array</i> that is larger than <b>BOOST_PP_LIMIT_TUPLE</b>,
  41. the result is undefined.
  42. </div>
  43. <h4>See Also</h4>
  44. <ul>
  45. <li><a href="array_insert.html">BOOST_PP_ARRAY_INSERT</a></li>
  46. </ul>
  47. <h4>Requirements</h4>
  48. <div>
  49. <b>Header:</b> &nbsp;<a href="../headers/array/insert.html">&lt;boost/preprocessor/array/insert.hpp&gt;</a>
  50. </div>
  51. <hr size="1">
  52. <div style="margin-left: 0px;">
  53. <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  54. </br><i>© Copyright Paul Mensonides 2002</i>
  55. </div>
  56. <div style="margin-left: 0px;">
  57. <p><small>Distributed under the Boost Software License, Version 1.0. (See
  58. accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  59. copy at <a href=
  60. "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  61. </div>
  62. </body>
  63. </html>