<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libstdc++: std::insert_iterator< _Container > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libstdc++</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00526.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">std::insert_iterator< _Container > Class Template Reference<div class="ingroups"><a class="el" href="a01201.html">Iterators</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="std::insert_iterator" --><!-- doxytag: inherits="iterator< output_iterator_tag, void, void, void, void >" -->
<p>Turns assignment into insertion.
<a href="a00526.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for std::insert_iterator< _Container >:</div>
<div class="dyncontent">
<div class="center"><img src="a02090.png" border="0" usemap="#std_1_1insert__iterator_3_01___container_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="std_1_1insert__iterator_3_01___container_01_4_inherit__map" id="std_1_1insert__iterator_3_01___container_01_4_inherit__map">
<area shape="rect" id="node2" href="a00260.html" title="std::iterator\< output_iterator_tag, void, void, void, void \>" alt="" coords="29,101,349,131"/><area shape="rect" id="node4" href="a00260.html" title="Common iterator class." alt="" coords="5,5,373,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a02091.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef _Container <a class="el" href="a00526.html#a81ef704d3e33bcb38d894a8b1e440771">container_type</a>
<li>typedef void <a class="el" href="a00260.html#a7fc5091a6bee76d7bfc6ece04e4050f9">difference_type</a>
<li>typedef <a class="el" href="a00647.html">output_iterator_tag</a> <a class="el" href="a00260.html#a3d32527bfebba5c0459df1390cef50a9">iterator_category</a>
<li>typedef void <a class="el" href="a00260.html#a69bffe0bd881194df5ff48fec79066de">pointer</a>
<li>typedef void <a class="el" href="a00260.html#abb17838f15d32971ad823036c6593aef">reference</a>
<li>typedef void <a class="el" href="a00260.html#af9f36b7adb257959eef192b9282f1284">value_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="a00526.html#a69916dd7c180bcb5fb6874adaaacc08b">insert_iterator</a> (_Container &__x, typename _Container::iterator __i)
<li><a class="el" href="a00526.html">insert_iterator</a> & <a class="el" href="a00526.html#a1a406c868feb4c886b002870abeb8546">operator*</a> ()
<li><a class="el" href="a00526.html">insert_iterator</a> & <a class="el" href="a00526.html#a66d30004d7402c9067fa8faadd7b8861">operator++</a> ()
<li><a class="el" href="a00526.html">insert_iterator</a> & <a class="el" href="a00526.html#a1d81a713bb24ef57aba0ce6dba2a84f0">operator++</a> (int)
<li><a class="el" href="a00526.html">insert_iterator</a> & <a class="el" href="a00526.html#a97b27e02a31008441dd0374c6a1021e4">operator=</a> (const typename _Container::value_type &__value)
<li><a class="anchor" id="ab0939880533e9a686dd5170a74a2a5e6"></a><!-- doxytag: member="std::insert_iterator::operator=" ref="ab0939880533e9a686dd5170a74a2a5e6" args="(typename _Container::value_type &&__value)" -->
<a class="el" href="a00526.html">insert_iterator</a> & <b>operator=</b> (typename _Container::value_type &&__value)
</ul>
<h2><a name="pro-attribs"></a>
Protected Attributes</h2>
<ul>
<li><a class="anchor" id="a2a506fe3dde282963629125f3367b7d8"></a><!-- doxytag: member="std::insert_iterator::container" ref="a2a506fe3dde282963629125f3367b7d8" args="" -->
_Container * <b>container</b>
<li><a class="anchor" id="a0dc823a8584eaa3d3abe3825ba544126"></a><!-- doxytag: member="std::insert_iterator::iter" ref="a0dc823a8584eaa3d3abe3825ba544126" args="" -->
_Container::iterator <b>iter</b>
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename _Container><br/>
class std::insert_iterator< _Container ></h3>
<p>Turns assignment into insertion. </p>
<p>These are output iterators, constructed from a container-of-T. Assigning a T to the iterator inserts it in the container at the iterator's position, rather than overwriting the value at that position.</p>
<p>(Sequences will actually insert a <em>copy</em> of the value before the iterator's position.)</p>
<p>Tip: Using the inserter function to create these iterators can save typing. </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00581">581</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a81ef704d3e33bcb38d894a8b1e440771"></a><!-- doxytag: member="std::insert_iterator::container_type" ref="a81ef704d3e33bcb38d894a8b1e440771" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container> </div>
<table class="memname">
<tr>
<td class="memname">typedef _Container <a class="el" href="a00526.html">std::insert_iterator</a>< _Container >::<a class="el" href="a00526.html#a81ef704d3e33bcb38d894a8b1e440771">container_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A nested typedef for the type of whatever container you used. </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00590">590</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7fc5091a6bee76d7bfc6ece04e4050f9"></a><!-- doxytag: member="std::insert_iterator::difference_type" ref="a7fc5091a6bee76d7bfc6ece04e4050f9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="a00260.html">std::iterator</a>< <a class="el" href="a00647.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a00260.html#a7fc5091a6bee76d7bfc6ece04e4050f9">difference_type</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Distance between iterators is represented as this type. </p>
<p>Definition at line <a class="el" href="a01054_source.html#l00126">126</a> of file <a class="el" href="a01054_source.html">stl_iterator_base_types.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3d32527bfebba5c0459df1390cef50a9"></a><!-- doxytag: member="std::insert_iterator::iterator_category" ref="a3d32527bfebba5c0459df1390cef50a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00647.html">output_iterator_tag</a> <a class="el" href="a00260.html">std::iterator</a>< <a class="el" href="a00647.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a00647.html">iterator_category</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>One of the <a class="el" href="a01202.html">tag types</a>. </p>
<p>Definition at line <a class="el" href="a01054_source.html#l00122">122</a> of file <a class="el" href="a01054_source.html">stl_iterator_base_types.h</a>.</p>
</div>
</div>
<a class="anchor" id="a69bffe0bd881194df5ff48fec79066de"></a><!-- doxytag: member="std::insert_iterator::pointer" ref="a69bffe0bd881194df5ff48fec79066de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="a00260.html">std::iterator</a>< <a class="el" href="a00647.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a00260.html#a69bffe0bd881194df5ff48fec79066de">pointer</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This type represents a pointer-to-value_type. </p>
<p>Definition at line <a class="el" href="a01054_source.html#l00128">128</a> of file <a class="el" href="a01054_source.html">stl_iterator_base_types.h</a>.</p>
</div>
</div>
<a class="anchor" id="abb17838f15d32971ad823036c6593aef"></a><!-- doxytag: member="std::insert_iterator::reference" ref="abb17838f15d32971ad823036c6593aef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="a00260.html">std::iterator</a>< <a class="el" href="a00647.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a00260.html#abb17838f15d32971ad823036c6593aef">reference</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This type represents a reference-to-value_type. </p>
<p>Definition at line <a class="el" href="a01054_source.html#l00130">130</a> of file <a class="el" href="a01054_source.html">stl_iterator_base_types.h</a>.</p>
</div>
</div>
<a class="anchor" id="af9f36b7adb257959eef192b9282f1284"></a><!-- doxytag: member="std::insert_iterator::value_type" ref="af9f36b7adb257959eef192b9282f1284" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="a00260.html">std::iterator</a>< <a class="el" href="a00647.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a00260.html#af9f36b7adb257959eef192b9282f1284">value_type</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The type "pointed to" by the iterator. </p>
<p>Definition at line <a class="el" href="a01054_source.html#l00124">124</a> of file <a class="el" href="a01054_source.html">stl_iterator_base_types.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a69916dd7c180bcb5fb6874adaaacc08b"></a><!-- doxytag: member="std::insert_iterator::insert_iterator" ref="a69916dd7c180bcb5fb6874adaaacc08b" args="(_Container &__x, typename _Container::iterator __i)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00526.html">std::insert_iterator</a>< _Container >::<a class="el" href="a00526.html">insert_iterator</a> </td>
<td>(</td>
<td class="paramtype">_Container & </td>
<td class="paramname"><em>__x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename _Container::iterator </td>
<td class="paramname"><em>__i</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The only way to create this iterator is with a container and an initial position (a normal iterator into the container). </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00596">596</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1a406c868feb4c886b002870abeb8546"></a><!-- doxytag: member="std::insert_iterator::operator*" ref="a1a406c868feb4c886b002870abeb8546" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00526.html">insert_iterator</a>& <a class="el" href="a00526.html">std::insert_iterator</a>< _Container >::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Simply returns *this. </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00650">650</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1d81a713bb24ef57aba0ce6dba2a84f0"></a><!-- doxytag: member="std::insert_iterator::operator++" ref="a1d81a713bb24ef57aba0ce6dba2a84f0" args="(int)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00526.html">insert_iterator</a>& <a class="el" href="a00526.html">std::insert_iterator</a>< _Container >::operator++ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Simply returns *this. (This iterator does not <em>move</em>.) </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00660">660</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a66d30004d7402c9067fa8faadd7b8861"></a><!-- doxytag: member="std::insert_iterator::operator++" ref="a66d30004d7402c9067fa8faadd7b8861" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00526.html">insert_iterator</a>& <a class="el" href="a00526.html">std::insert_iterator</a>< _Container >::operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Simply returns *this. (This iterator does not <em>move</em>.) </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00655">655</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a97b27e02a31008441dd0374c6a1021e4"></a><!-- doxytag: member="std::insert_iterator::operator=" ref="a97b27e02a31008441dd0374c6a1021e4" args="(const typename _Container::value_type &__value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00526.html">insert_iterator</a>& <a class="el" href="a00526.html">std::insert_iterator</a>< _Container >::operator= </td>
<td>(</td>
<td class="paramtype">const typename _Container::value_type & </td>
<td class="paramname"><em>__value</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>An instance of whatever type container_type::const_reference is; presumably a reference-to-const T for container<T>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>This iterator, for chained operations.</dd></dl>
<p>This kind of iterator maintains its own position in the container. Assigning a value to the iterator will insert the value into the container at the place before the iterator.</p>
<p>The position is maintained such that subsequent assignments will insert values immediately after one another. For example, </p>
<div class="fragment"><pre class="fragment"> <span class="comment">// vector v contains A and Z</span>
<a class="code" href="a00526.html#a69916dd7c180bcb5fb6874adaaacc08b">insert_iterator</a> i (v, ++v.begin());
i = 1;
i = 2;
i = 3;
<span class="comment">// vector v contains A, 1, 2, 3, and Z</span>
</pre></div>
<p>Definition at line <a class="el" href="a01052_source.html#l00632">632</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a01052_source.html">stl_iterator.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a01137.html">std</a> </li>
<li class="navelem"><a class="el" href="a00526.html">insert_iterator</a> </li>
<li class="footer">Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
</body>
</html>
