2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" />
2004-11-28 03:35:12 +00:00
< title > The MPL Reference Manual: insert</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
< 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 >
< 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 >
</ tr ></ table >< div class = "header-separator" ></ div >
< div class = "section" id = "insert" >
2010-08-09 20:07:24 +00:00
< h1 >< a class = "toc-backref" href = "./intrinsic-metafunctions.html#id1436" > insert</ a ></ h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id274" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#synopsis" name = "synopsis" > Synopsis</ a ></ h3 >
< pre class = "literal-block" >
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename Sequence
, typename Pos
2009-08-17 11:30:52 +00:00
, typename T
2004-11-28 03:35:12 +00:00
>
struct < a href = "./insert.html" class = "identifier" > insert</ a >
{
typedef < em > unspecified</ em > type;
};
2009-08-17 11:30:52 +00:00
template<
2004-11-28 03:35:12 +00:00
typename Sequence
2009-08-17 11:30:52 +00:00
, typename T
2004-11-28 03:35:12 +00:00
>
struct < a href = "./insert.html" class = "identifier" > insert</ a >
{
typedef < em > unspecified</ em > type;
};
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id275" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< 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 >
2004-11-28 03:35:12 +00:00
< ul class = "simple" >
< li >< tt class = "literal" >< span class = "pre" >< a href = "./insert.html" class = "identifier" > insert</ a > < Sequence,Pos,T> </ span ></ tt > performs an insertion of
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
2009-08-17 11:30:52 +00:00
< 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 >
< 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
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 >
2004-11-28 03:35:12 +00:00
</ ul >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id276" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#header" name = "header" > Header</ a ></ h3 >
< pre class = "literal-block" >
#include < < a href = "../../../../boost/mpl/insert.hpp" class = "header" > boost/mpl/insert.hpp</ a > >
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id277" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#model-of" name = "model-of" > Model of</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./tag-dispatched-metafunction.html" > Tag Dispatched Metafunction</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id278" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#parameters" name = "parameters" > Parameters</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "15%" />
< col width = "36%" />
< col width = "48%" />
</ colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr >< th class = "head" > Parameter</ th >
< th class = "head" > Requirement</ th >
< th class = "head" > Description</ th >
2004-11-28 03:35:12 +00:00
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td >< tt class = "literal" >< span class = "pre" > Sequence</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence</ a > or
< a class = "reference internal" href = "./extensible-associative-sequence.html" > Extensible Associative Sequence</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > A sequence to insert into.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > Pos</ span ></ tt ></ td >
2009-08-17 11:30:52 +00:00
< td >< a class = "reference internal" href = "./forward-iterator.html" > Forward Iterator</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > An iterator in < tt class = "literal" >< span class = "pre" > Sequence</ span ></ tt > specifying the
insertion position.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > T</ span ></ tt ></ td >
< td > Any type</ td >
< td > The element to be inserted.</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id279" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics</ a ></ h3 >
< div class = "expression-semantics compound" >
2009-08-17 11:30:52 +00:00
< 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 >
2004-11-28 03:35:12 +00:00
< pre class = "compound-middle literal-block" >
2009-08-17 11:30:52 +00:00
typedef < a href = "./insert.html" class = "identifier" > insert</ a > < s,pos,x> ::type r;
2004-11-28 03:35:12 +00:00
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "compound-last docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< 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 >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
2009-08-17 11:30:52 +00:00
< 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 >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
2009-08-17 11:30:52 +00:00
< 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:
[< 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 >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
< 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 >
< pre class = "literal-block" >
< 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
</ pre >
< p > is identical to < tt class = "literal" >< span class = "pre" > x</ span ></ tt > ;</ p >
< pre class = "last literal-block" >
2009-08-17 11:30:52 +00:00
< a href = "./size.html" class = "identifier" > size</ a > < r> ::value == < a href = "./size.html" class = "identifier" > size</ a > < s> ::value + 1;
2004-11-28 03:35:12 +00:00
</ pre >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
< div class = "expression-semantics compound" >
2009-08-17 11:30:52 +00:00
< 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 > ,
2004-11-28 03:35:12 +00:00
and arbitrary type < tt class = "literal" >< span class = "pre" > x</ span ></ tt > :</ p >
< pre class = "compound-middle literal-block" >
2009-08-17 11:30:52 +00:00
typedef < a href = "./insert.html" class = "identifier" > insert</ a > < s,x> ::type r;
2004-11-28 03:35:12 +00:00
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "compound-middle docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< 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 >
2004-11-28 03:35:12 +00:00
</ tr >
2009-08-17 11:30:52 +00:00
< 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
2004-11-28 03:35:12 +00:00
< 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 >
</ tr >
< 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 >
</ tr >
</ tbody >
</ table >
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
< pre class = "compound-middle literal-block" >
2009-08-17 11:30:52 +00:00
typedef < a href = "./insert.html" class = "identifier" > insert</ a > < s,pos,x> ::type r;
2004-11-28 03:35:12 +00:00
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "compound-last docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< 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 >
2004-11-28 03:35:12 +00:00
</ tr >
< 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 >
</ tr >
< 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 >
</ tr >
</ tbody >
</ table >
</ div >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id280" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#complexity" name = "complexity" > Complexity</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "45%" />
< col width = "55%" />
</ colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr >< th class = "head" > Sequence archetype</ th >
< th class = "head" > Complexity</ th >
2004-11-28 03:35:12 +00:00
</ tr >
</ thead >
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr >< td >< a class = "reference internal" href = "./extensible-associative-sequence.html" > Extensible Associative Sequence</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > Amortized constant time.</ td >
</ tr >
2009-08-17 11:30:52 +00:00
< tr >< td >< a class = "reference internal" href = "./extensible-sequence.html" > Extensible Sequence</ a ></ td >
2004-11-28 03:35:12 +00:00
< td > Linear in the worst case, or amortized
constant time.</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id281" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#example" name = "example" > Example</ a ></ h3 >
< pre class = "literal-block" >
typedef < a href = "./vector-c.html" class = "identifier" > vector_c</ a > < int,0,1,3,4,5,6,7,8,9> numbers;
typedef < a href = "./find.html" class = "identifier" > find</ a > < numbers,< a href = "./integral-c.html" class = "identifier" > integral_c</ a > < int,3> > ::type pos;
typedef < a href = "./insert.html" class = "identifier" > insert</ a > < numbers,pos,< a href = "./integral-c.html" class = "identifier" > integral_c</ a > < int,2> > ::type range;
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( < a href = "./size.html" class = "identifier" > size</ a > < range> ::value, ==, 10 );
< 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> > ));
</ pre >
< pre class = "literal-block" >
typedef < a href = "./map.html" class = "identifier" > map</ a > < mpl::< a href = "./pair.html" class = "identifier" > pair</ a > < int,unsigned> > m;
typedef < a href = "./insert.html" class = "identifier" > insert</ a > < m,mpl::< a href = "./pair.html" class = "identifier" > pair</ a > < char,long> > ::type m1;
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( < a href = "./size.html" class = "identifier" > size</ a > < m1> ::value, ==, 2 );
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< < a href = "./at.html" class = "identifier" > at</ a > < m1,int> ::type,unsigned > ));
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< < a href = "./at.html" class = "identifier" > at</ a > < m1,char> ::type,long > ));
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id282" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#see-also" name = "see-also" > See also</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< 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 >
2004-11-28 03:35:12 +00:00
<!-- Sequences/Intrinsic Metafunctions//insert_range -->
</ div >
</ div >
< div class = "footer-separator" ></ div >
< 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 >
2009-08-17 11:30:52 +00:00
< td >< div class = "copyright-footer" >< div class = "copyright" > Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</ div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
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 >
2004-11-28 03:35:12 +00:00
</ html >
