insert.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
  7. <title>The MPL Reference Manual: insert</title>
  8. <link rel="stylesheet" href="../style.css" type="text/css" />
  9. </head>
  10. <body class="docframe refmanual">
  11. <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./has-key.html" class="navigation-link">Prev</a>&nbsp;<a href="./insert-range.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./has-key.html" class="navigation-link">Back</a>&nbsp;<a href="./insert-range.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  12. <td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./sequences.html" class="navigation-link">Sequences</a> / <a href="./intrinsic-metafunctions.html" class="navigation-link">Intrinsic Metafunctions</a> / <a href="./insert.html" class="navigation-link">insert</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="insert">
  15. <h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id1436">insert</a></h1>
  16. <div class="section" id="id274">
  17. <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18. <pre class="literal-block">
  19. template&lt;
  20. typename Sequence
  21. , typename Pos
  22. , typename T
  23. &gt;
  24. struct <a href="./insert.html" class="identifier">insert</a>
  25. {
  26. typedef <em>unspecified</em> type;
  27. };
  28. template&lt;
  29. typename Sequence
  30. , typename T
  31. &gt;
  32. struct <a href="./insert.html" class="identifier">insert</a>
  33. {
  34. typedef <em>unspecified</em> type;
  35. };
  36. </pre>
  37. </div>
  38. <div class="section" id="id275">
  39. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  40. <p><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a></span></tt> is an <a class="reference internal" href="./terminology.html#overloaded-name">overloaded name</a>:</p>
  41. <ul class="simple">
  42. <li><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;Sequence,Pos,T&gt;</span></tt> performs an insertion of
  43. type <tt class="literal"><span class="pre">T</span></tt> at an arbitrary position <tt class="literal"><span class="pre">Pos</span></tt> in <tt class="literal"><span class="pre">Sequence</span></tt>. <tt class="literal"><span class="pre">Pos</span></tt> is ignored is
  44. <tt class="literal"><span class="pre">Sequence</span></tt> is a model of <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>.</li>
  45. <li><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;Sequence,T&gt;</span></tt> is a shortcut notation for <tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;Sequence,Pos,T&gt;</span></tt> for the
  46. case when <tt class="literal"><span class="pre">Sequence</span></tt> is a model of <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>.</li>
  47. </ul>
  48. </div>
  49. <div class="section" id="id276">
  50. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  51. <pre class="literal-block">
  52. #include &lt;<a href="../../../../boost/mpl/insert.hpp" class="header">boost/mpl/insert.hpp</a>&gt;
  53. </pre>
  54. </div>
  55. <div class="section" id="id277">
  56. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  57. <p><a class="reference internal" href="./tag-dispatched-metafunction.html">Tag Dispatched Metafunction</a></p>
  58. </div>
  59. <div class="section" id="id278">
  60. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  61. <table border="1" class="docutils table">
  62. <colgroup>
  63. <col width="15%" />
  64. <col width="36%" />
  65. <col width="48%" />
  66. </colgroup>
  67. <thead valign="bottom">
  68. <tr><th class="head">Parameter</th>
  69. <th class="head">Requirement</th>
  70. <th class="head">Description</th>
  71. </tr>
  72. </thead>
  73. <tbody valign="top">
  74. <tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
  75. <td><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a> or
  76. <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  77. <td>A sequence to insert into.</td>
  78. </tr>
  79. <tr><td><tt class="literal"><span class="pre">Pos</span></tt></td>
  80. <td><a class="reference internal" href="./forward-iterator.html">Forward Iterator</a></td>
  81. <td>An iterator in <tt class="literal"><span class="pre">Sequence</span></tt> specifying the
  82. insertion position.</td>
  83. </tr>
  84. <tr><td><tt class="literal"><span class="pre">T</span></tt></td>
  85. <td>Any type</td>
  86. <td>The element to be inserted.</td>
  87. </tr>
  88. </tbody>
  89. </table>
  90. </div>
  91. <div class="section" id="id279">
  92. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  93. <div class="expression-semantics compound">
  94. <p class="compound-first">For any <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, iterator <tt class="literal"><span class="pre">pos</span></tt> in <tt class="literal"><span class="pre">s</span></tt>, and arbitrary type <tt class="literal"><span class="pre">x</span></tt>:</p>
  95. <pre class="compound-middle literal-block">
  96. typedef <a href="./insert.html" class="identifier">insert</a>&lt;s,pos,x&gt;::type r;
  97. </pre>
  98. <table class="compound-last docutils field-list" frame="void" rules="none">
  99. <col class="field-name" />
  100. <col class="field-body" />
  101. <tbody valign="top">
  102. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a></p>
  103. </td>
  104. </tr>
  105. <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">pos</span></tt> is an iterator in <tt class="literal"><span class="pre">s</span></tt>.</p>
  106. </td>
  107. </tr>
  108. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">r</span></tt> is a sequence, <a class="reference internal" href="./terminology.html#concept-identical">concept-identical</a> to <tt class="literal"><span class="pre">s</span></tt>, of the following elements:
  109. [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type</span></tt>, <tt class="literal"><span class="pre">pos</span></tt>), <tt class="literal"><span class="pre">x</span></tt>, [<tt class="literal"><span class="pre">pos</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt>).</p>
  110. </td>
  111. </tr>
  112. <tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><p class="first">The relative order of the elements in <tt class="literal"><span class="pre">r</span></tt> is the same as in <tt class="literal"><span class="pre">s</span></tt>.</p>
  113. <pre class="literal-block">
  114. <a href="./at.html" class="identifier">at</a>&lt; r, <a href="./distance.html" class="identifier">distance</a>&lt; <a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type,pos &gt;::type &gt;::type
  115. </pre>
  116. <p>is identical to <tt class="literal"><span class="pre">x</span></tt>;</p>
  117. <pre class="last literal-block">
  118. <a href="./size.html" class="identifier">size</a>&lt;r&gt;::value == <a href="./size.html" class="identifier">size</a>&lt;s&gt;::value + 1;
  119. </pre>
  120. </td>
  121. </tr>
  122. </tbody>
  123. </table>
  124. </div>
  125. <div class="expression-semantics compound">
  126. <p class="compound-first">For any <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, iterator <tt class="literal"><span class="pre">pos</span></tt> in <tt class="literal"><span class="pre">s</span></tt>,
  127. and arbitrary type <tt class="literal"><span class="pre">x</span></tt>:</p>
  128. <pre class="compound-middle literal-block">
  129. typedef <a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type r;
  130. </pre>
  131. <table class="compound-middle docutils field-list" frame="void" rules="none">
  132. <col class="field-name" />
  133. <col class="field-body" />
  134. <tbody valign="top">
  135. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  136. </tr>
  137. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><tt class="literal"><span class="pre">r</span></tt> is <a class="reference internal" href="./terminology.html#concept-identical">concept-identical</a> and equivalent to <tt class="literal"><span class="pre">s</span></tt>, except that
  138. <tt class="literal"><span class="pre"><a href="./at.html" class="identifier">at</a>&lt;</span> <span class="pre">r,</span> <span class="pre"><a href="./key-type.html" class="identifier">key_type</a>&lt;s,x&gt;::type</span> <span class="pre">&gt;::type</span></tt> is identical to <tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a>&lt;s,x&gt;::type</span></tt>.</td>
  139. </tr>
  140. <tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;r&gt;::value</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">+</span> <span class="pre">1</span></tt>.</td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
  145. <pre class="compound-middle literal-block">
  146. typedef <a href="./insert.html" class="identifier">insert</a>&lt;s,pos,x&gt;::type r;
  147. </pre>
  148. <table class="compound-last docutils field-list" frame="void" rules="none">
  149. <col class="field-name" />
  150. <col class="field-body" />
  151. <tbody valign="top">
  152. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  153. </tr>
  154. <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><tt class="literal"><span class="pre">pos</span></tt> is an iterator in <tt class="literal"><span class="pre">s</span></tt>.</td>
  155. </tr>
  156. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body">Equivalent to <tt class="literal"><span class="pre">typedef</span> <span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type</span> <span class="pre">r</span></tt>; <tt class="literal"><span class="pre">pos</span></tt> is ignored.</td>
  157. </tr>
  158. </tbody>
  159. </table>
  160. </div>
  161. </div>
  162. <div class="section" id="id280">
  163. <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  164. <table border="1" class="docutils table">
  165. <colgroup>
  166. <col width="45%" />
  167. <col width="55%" />
  168. </colgroup>
  169. <thead valign="bottom">
  170. <tr><th class="head">Sequence archetype</th>
  171. <th class="head">Complexity</th>
  172. </tr>
  173. </thead>
  174. <tbody valign="top">
  175. <tr><td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  176. <td>Amortized constant time.</td>
  177. </tr>
  178. <tr><td><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a></td>
  179. <td>Linear in the worst case, or amortized
  180. constant time.</td>
  181. </tr>
  182. </tbody>
  183. </table>
  184. </div>
  185. <div class="section" id="id281">
  186. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  187. <pre class="literal-block">
  188. typedef <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,0,1,3,4,5,6,7,8,9&gt; numbers;
  189. typedef <a href="./find.html" class="identifier">find</a>&lt; numbers,<a href="./integral-c.html" class="identifier">integral_c</a>&lt;int,3&gt; &gt;::type pos;
  190. typedef <a href="./insert.html" class="identifier">insert</a>&lt; numbers,pos,<a href="./integral-c.html" class="identifier">integral_c</a>&lt;int,2&gt; &gt;::type range;
  191. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;range&gt;::value, ==, 10 );
  192. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>&lt; range,<a href="./range-c.html" class="identifier">range_c</a>&lt;int,0,10&gt; > ));
  193. </pre>
  194. <pre class="literal-block">
  195. typedef <a href="./map.html" class="identifier">map</a>&lt; mpl::<a href="./pair.html" class="identifier">pair</a>&lt;int,unsigned&gt; &gt; m;
  196. typedef <a href="./insert.html" class="identifier">insert</a>&lt;m,mpl::<a href="./pair.html" class="identifier">pair</a>&lt;char,long&gt; &gt;::type m1;
  197. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;m1&gt;::value, ==, 2 );
  198. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m1,int&gt;::type,unsigned &gt; ));
  199. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m1,char&gt;::type,long > ));
  200. </pre>
  201. </div>
  202. <div class="section" id="id282">
  203. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  204. <p><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>, <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>, <a class="reference internal" href="./insert-range.html">insert_range</a>, <a class="reference internal" href="./push-front.html">push_front</a>, <a class="reference internal" href="./push-back.html">push_back</a>, <a class="reference internal" href="./erase.html">erase</a></p>
  205. <!-- Sequences/Intrinsic Metafunctions//insert_range -->
  206. </div>
  207. </div>
  208. <div class="footer-separator"></div>
  209. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./has-key.html" class="navigation-link">Prev</a>&nbsp;<a href="./insert-range.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./has-key.html" class="navigation-link">Back</a>&nbsp;<a href="./insert-range.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  210. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  211. Distributed under the Boost Software License, Version 1.0. (See accompanying
  212. file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body>
  213. </html>