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> <a href="./insert-range.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./has-key.html" class="navigation-link">Back</a> <a href="./insert-range.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </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"> 19template< 20 typename Sequence 21 , typename Pos 22 , typename T 23 > 24struct <a href="./insert.html" class="identifier">insert</a> 25{ 26 typedef <em>unspecified</em> type; 27}; 28 29 30template< 31 typename Sequence 32 , typename T 33 > 34struct <a href="./insert.html" class="identifier">insert</a> 35{ 36 typedef <em>unspecified</em> type; 37}; 38</pre> 39</div> 40<div class="section" id="id275"> 41<h3><a class="subsection-title" href="#description" name="description">Description</a></h3> 42<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> 43<ul class="simple"> 44<li><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a><Sequence,Pos,T></span></tt> performs an insertion of 45type <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 46<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<li><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a><Sequence,T></span></tt> is a shortcut notation for <tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a><Sequence,Pos,T></span></tt> for the 48case 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> 49</ul> 50</div> 51<div class="section" id="id276"> 52<h3><a class="subsection-title" href="#header" name="header">Header</a></h3> 53<pre class="literal-block"> 54#include <<a href="../../../../boost/mpl/insert.hpp" class="header">boost/mpl/insert.hpp</a>> 55</pre> 56</div> 57<div class="section" id="id277"> 58<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> 59<p><a class="reference internal" href="./tag-dispatched-metafunction.html">Tag Dispatched Metafunction</a></p> 60</div> 61<div class="section" id="id278"> 62<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> 63<table border="1" class="docutils table"> 64<colgroup> 65<col width="15%" /> 66<col width="36%" /> 67<col width="48%" /> 68</colgroup> 69<thead valign="bottom"> 70<tr><th class="head">Parameter</th> 71<th class="head">Requirement</th> 72<th class="head">Description</th> 73</tr> 74</thead> 75<tbody valign="top"> 76<tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td> 77<td><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a> or 78<a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td> 79<td>A sequence to insert into.</td> 80</tr> 81<tr><td><tt class="literal"><span class="pre">Pos</span></tt></td> 82<td><a class="reference internal" href="./forward-iterator.html">Forward Iterator</a></td> 83<td>An iterator in <tt class="literal"><span class="pre">Sequence</span></tt> specifying the 84insertion position.</td> 85</tr> 86<tr><td><tt class="literal"><span class="pre">T</span></tt></td> 87<td>Any type</td> 88<td>The element to be inserted.</td> 89</tr> 90</tbody> 91</table> 92</div> 93<div class="section" id="id279"> 94<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> 95<div class="expression-semantics compound"> 96<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> 97<pre class="compound-middle literal-block"> 98typedef <a href="./insert.html" class="identifier">insert</a><s,pos,x>::type r; 99</pre> 100<table class="compound-last docutils field-list" frame="void" rules="none"> 101<col class="field-name" /> 102<col class="field-body" /> 103<tbody valign="top"> 104<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> 105</td> 106</tr> 107<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> 108</td> 109</tr> 110<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: 111[<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a><s>::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><s>::type</span></tt>).</p> 112</td> 113</tr> 114<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> 115<pre class="literal-block"> 116<a href="./at.html" class="identifier">at</a>< r, <a href="./distance.html" class="identifier">distance</a>< <a href="./begin.html" class="identifier">begin</a><s>::type,pos >::type >::type 117</pre> 118<p>is identical to <tt class="literal"><span class="pre">x</span></tt>;</p> 119<pre class="last literal-block"> 120<a href="./size.html" class="identifier">size</a><r>::value == <a href="./size.html" class="identifier">size</a><s>::value + 1; 121</pre> 122</td> 123</tr> 124</tbody> 125</table> 126</div> 127<div class="expression-semantics compound"> 128<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>, 129and arbitrary type <tt class="literal"><span class="pre">x</span></tt>:</p> 130<pre class="compound-middle literal-block"> 131typedef <a href="./insert.html" class="identifier">insert</a><s,x>::type r; 132</pre> 133<table class="compound-middle docutils field-list" frame="void" rules="none"> 134<col class="field-name" /> 135<col class="field-body" /> 136<tbody valign="top"> 137<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> 138</tr> 139<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 140<tt class="literal"><span class="pre"><a href="./at.html" class="identifier">at</a><</span> <span class="pre">r,</span> <span class="pre"><a href="./key-type.html" class="identifier">key_type</a><s,x>::type</span> <span class="pre">>::type</span></tt> is identical to <tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a><s,x>::type</span></tt>.</td> 141</tr> 142<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><r>::value</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a><s>::value</span> <span class="pre">+</span> <span class="pre">1</span></tt>.</td> 143</tr> 144</tbody> 145</table> 146<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> 147<pre class="compound-middle literal-block"> 148typedef <a href="./insert.html" class="identifier">insert</a><s,pos,x>::type r; 149</pre> 150<table class="compound-last docutils field-list" frame="void" rules="none"> 151<col class="field-name" /> 152<col class="field-body" /> 153<tbody valign="top"> 154<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> 155</tr> 156<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> 157</tr> 158<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><s,x>::type</span> <span class="pre">r</span></tt>; <tt class="literal"><span class="pre">pos</span></tt> is ignored.</td> 159</tr> 160</tbody> 161</table> 162</div> 163</div> 164<div class="section" id="id280"> 165<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3> 166<table border="1" class="docutils table"> 167<colgroup> 168<col width="45%" /> 169<col width="55%" /> 170</colgroup> 171<thead valign="bottom"> 172<tr><th class="head">Sequence archetype</th> 173<th class="head">Complexity</th> 174</tr> 175</thead> 176<tbody valign="top"> 177<tr><td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td> 178<td>Amortized constant time.</td> 179</tr> 180<tr><td><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a></td> 181<td>Linear in the worst case, or amortized 182constant time.</td> 183</tr> 184</tbody> 185</table> 186</div> 187<div class="section" id="id281"> 188<h3><a class="subsection-title" href="#example" name="example">Example</a></h3> 189<pre class="literal-block"> 190typedef <a href="./vector-c.html" class="identifier">vector_c</a><int,0,1,3,4,5,6,7,8,9> numbers; 191typedef <a href="./find.html" class="identifier">find</a>< numbers,<a href="./integral-c.html" class="identifier">integral_c</a><int,3> >::type pos; 192typedef <a href="./insert.html" class="identifier">insert</a>< numbers,pos,<a href="./integral-c.html" class="identifier">integral_c</a><int,2> >::type range; 193 194<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a><range>::value, ==, 10 ); 195<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>< range,<a href="./range-c.html" class="identifier">range_c</a><int,0,10> > )); 196</pre> 197<pre class="literal-block"> 198typedef <a href="./map.html" class="identifier">map</a>< mpl::<a href="./pair.html" class="identifier">pair</a><int,unsigned> > m; 199typedef <a href="./insert.html" class="identifier">insert</a><m,mpl::<a href="./pair.html" class="identifier">pair</a><char,long> >::type m1; 200 201<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a><m1>::value, ==, 2 ); 202<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./at.html" class="identifier">at</a><m1,int>::type,unsigned > )); 203<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./at.html" class="identifier">at</a><m1,char>::type,long > )); 204</pre> 205</div> 206<div class="section" id="id282"> 207<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> 208<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> 209<!-- Sequences/Intrinsic Metafunctions//insert_range --> 210</div> 211</div> 212 213<div class="footer-separator"></div> 214<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> <a href="./insert-range.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./has-key.html" class="navigation-link">Back</a> <a href="./insert-range.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> 215<td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div> 216Distributed under the Boost Software License, Version 1.0. (See accompanying 217file 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> 218</html> 219