tuple_insert_d.html 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <html>
  2. <head>
  3. <meta content="text/html; charset=windows-1252" http-equiv="content-type">
  4. <title>BOOST_PP_TUPLE_INSERT_D</title>
  5. <link rel="stylesheet" type="text/css" href="../styles.css">
  6. </head>
  7. <body>
  8. <div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_INSERT_D</b> macro
  9. inserts an element into a <i>tuple</i>.&nbsp; It reenters <b>BOOST_PP_WHILE</b>
  10. with maximum efficiency.</div>
  11. <h4>Usage</h4>
  12. <div class="code"> <b>BOOST_PP_TUPLE_INSERT_D</b>(<i>d</i>, <i>tuple</i>,
  13. <i>i</i>, <i>elem</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
  14. <h4>Arguments</h4>
  15. <dl>
  16. <dt>d</dt>
  17. <dd> The next available <b>BOOST_PP_WHILE</b> iteration. </dd>
  18. <dt>tuple</dt>
  19. <dd> The <i>tuple</i> into which an element is to be inserted.</dd>
  20. <dt>i</dt>
  21. <dd> The zero-based position in <i>tuple</i> where an element is to be
  22. inserted.&nbsp; Valid values range from <i>0</i> to <b>BOOST_PP_TUPLE_SIZE</b>(<i>tuple</i>).</dd>
  23. <dt>elem</dt>
  24. <dd> The element to insert. </dd>
  25. </dl>
  26. <h4>Remarks</h4>
  27. <div> This macro inserts <i>elem</i> before the element at index <i>i</i>.
  28. </div>
  29. <div> If the operation attempts to create an <i>tuple</i> that is larger
  30. than <b>BOOST_PP_LIMIT_TUPLE</b>, the result is undefined.</div>
  31. <h4>See Also</h4>
  32. <ul>
  33. <li><a href="tuple_insert.html">BOOST_PP_TUPLE_INSERT</a></li>
  34. </ul>
  35. <h4>Requirements</h4>
  36. <div> <b>Header:</b> &nbsp;<a href="../headers/tuple/insert.html">&lt;boost/preprocessor/tuple/insert.hpp&gt;</a>
  37. </div>
  38. <hr size="1">
  39. <div style="margin-left: 0px;"> <i>© Copyright Edward Diener 2013</i> </div>
  40. <div style="margin-left: 0px;">
  41. <p><small>Distributed under the Boost Software License, Version 1.0. (See
  42. accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
  43. or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  44. </div>
  45. </body>
  46. </html>