<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: std::insert_iterator< _Container > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('a07628.html','');}); /* @license-end */ </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> | <a href="a07625.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::insert_iterator< _Container > Class Template Reference<div class="ingroups"><a class="el" href="a01504.html">Iterators</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Inheritance diagram for std::insert_iterator< _Container >:</div> <div class="dyncontent"> <div class="center"><iframe scrolling="no" frameborder="0" src="a07627.svg" width="138" height="150"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> </div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a81ef704d3e33bcb38d894a8b1e440771"><td class="memItemLeft" align="right" valign="top">typedef _Container </td><td class="memItemRight" valign="bottom"><a class="el" href="a07628.html#a81ef704d3e33bcb38d894a8b1e440771">container_type</a></td></tr> <tr class="separator:a81ef704d3e33bcb38d894a8b1e440771"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7fc5091a6bee76d7bfc6ece04e4050f9"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="a07672.html#a7fc5091a6bee76d7bfc6ece04e4050f9">difference_type</a></td></tr> <tr class="separator:a7fc5091a6bee76d7bfc6ece04e4050f9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3d32527bfebba5c0459df1390cef50a9"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="a07656.html">output_iterator_tag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a07672.html#a3d32527bfebba5c0459df1390cef50a9">iterator_category</a></td></tr> <tr class="separator:a3d32527bfebba5c0459df1390cef50a9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a69bffe0bd881194df5ff48fec79066de"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="a07672.html#a69bffe0bd881194df5ff48fec79066de">pointer</a></td></tr> <tr class="separator:a69bffe0bd881194df5ff48fec79066de"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abb17838f15d32971ad823036c6593aef"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="a07672.html#abb17838f15d32971ad823036c6593aef">reference</a></td></tr> <tr class="separator:abb17838f15d32971ad823036c6593aef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af9f36b7adb257959eef192b9282f1284"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="a07672.html#af9f36b7adb257959eef192b9282f1284">value_type</a></td></tr> <tr class="separator:af9f36b7adb257959eef192b9282f1284"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a69916dd7c180bcb5fb6874adaaacc08b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a07628.html#a69916dd7c180bcb5fb6874adaaacc08b">insert_iterator</a> (_Container &__x, typename _Container::iterator __i)</td></tr> <tr class="separator:a69916dd7c180bcb5fb6874adaaacc08b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1a406c868feb4c886b002870abeb8546"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a07628.html">insert_iterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a07628.html#a1a406c868feb4c886b002870abeb8546">operator*</a> ()</td></tr> <tr class="separator:a1a406c868feb4c886b002870abeb8546"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a66d30004d7402c9067fa8faadd7b8861"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a07628.html">insert_iterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a07628.html#a66d30004d7402c9067fa8faadd7b8861">operator++</a> ()</td></tr> <tr class="separator:a66d30004d7402c9067fa8faadd7b8861"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d81a713bb24ef57aba0ce6dba2a84f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a07628.html">insert_iterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a07628.html#a1d81a713bb24ef57aba0ce6dba2a84f0">operator++</a> (int)</td></tr> <tr class="separator:a1d81a713bb24ef57aba0ce6dba2a84f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a97b27e02a31008441dd0374c6a1021e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a07628.html">insert_iterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a07628.html#a97b27e02a31008441dd0374c6a1021e4">operator=</a> (const typename _Container::value_type &__value)</td></tr> <tr class="separator:a97b27e02a31008441dd0374c6a1021e4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0939880533e9a686dd5170a74a2a5e6"><td class="memItemLeft" align="right" valign="top"><a id="ab0939880533e9a686dd5170a74a2a5e6"></a> <a class="el" href="a07628.html">insert_iterator</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (typename _Container::value_type &&__value)</td></tr> <tr class="separator:ab0939880533e9a686dd5170a74a2a5e6"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:a2a506fe3dde282963629125f3367b7d8"><td class="memItemLeft" align="right" valign="top"><a id="a2a506fe3dde282963629125f3367b7d8"></a> _Container * </td><td class="memItemRight" valign="bottom"><b>container</b></td></tr> <tr class="separator:a2a506fe3dde282963629125f3367b7d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0dc823a8584eaa3d3abe3825ba544126"><td class="memItemLeft" align="right" valign="top"><a id="a0dc823a8584eaa3d3abe3825ba544126"></a> _Container::iterator </td><td class="memItemRight" valign="bottom"><b>iter</b></td></tr> <tr class="separator:a0dc823a8584eaa3d3abe3825ba544126"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">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 class="definition">Definition at line <a class="el" href="a17142_source.html#l00642">642</a> of file <a class="el" href="a17142_source.html">bits/stl_iterator.h</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a id="a81ef704d3e33bcb38d894a8b1e440771"></a> <h2 class="memtitle"><span class="permalink"><a href="#a81ef704d3e33bcb38d894a8b1e440771">◆ </a></span>container_type</h2> <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="a07628.html">std::insert_iterator</a>< _Container >::<a class="el" href="a07628.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 class="definition">Definition at line <a class="el" href="a17142_source.html#l00651">651</a> of file <a class="el" href="a17142_source.html">bits/stl_iterator.h</a>.</p> </div> </div> <a id="a7fc5091a6bee76d7bfc6ece04e4050f9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7fc5091a6bee76d7bfc6ece04e4050f9">◆ </a></span>difference_type</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">typedef void <a class="el" href="a07672.html">std::iterator</a>< <a class="el" href="a07656.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a07672.html#a7fc5091a6bee76d7bfc6ece04e4050f9">difference_type</a></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Distance between iterators is represented as this type. </p> <p class="definition">Definition at line <a class="el" href="a00554_source.html#l00125">125</a> of file <a class="el" href="a00554_source.html">stl_iterator_base_types.h</a>.</p> </div> </div> <a id="a3d32527bfebba5c0459df1390cef50a9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3d32527bfebba5c0459df1390cef50a9">◆ </a></span>iterator_category</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a07656.html">output_iterator_tag</a> <a class="el" href="a07672.html">std::iterator</a>< <a class="el" href="a07656.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a07672.html#a3d32527bfebba5c0459df1390cef50a9">iterator_category</a></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>One of the <a class="el" href="a01505.html">tag types</a>. </p> <p class="definition">Definition at line <a class="el" href="a00554_source.html#l00121">121</a> of file <a class="el" href="a00554_source.html">stl_iterator_base_types.h</a>.</p> </div> </div> <a id="a69bffe0bd881194df5ff48fec79066de"></a> <h2 class="memtitle"><span class="permalink"><a href="#a69bffe0bd881194df5ff48fec79066de">◆ </a></span>pointer</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">typedef void <a class="el" href="a07672.html">std::iterator</a>< <a class="el" href="a07656.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a07672.html#a69bffe0bd881194df5ff48fec79066de">pointer</a></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This type represents a pointer-to-value_type. </p> <p class="definition">Definition at line <a class="el" href="a00554_source.html#l00127">127</a> of file <a class="el" href="a00554_source.html">stl_iterator_base_types.h</a>.</p> </div> </div> <a id="abb17838f15d32971ad823036c6593aef"></a> <h2 class="memtitle"><span class="permalink"><a href="#abb17838f15d32971ad823036c6593aef">◆ </a></span>reference</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">typedef void <a class="el" href="a07672.html">std::iterator</a>< <a class="el" href="a07656.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a07672.html#abb17838f15d32971ad823036c6593aef">reference</a></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This type represents a reference-to-value_type. </p> <p class="definition">Definition at line <a class="el" href="a00554_source.html#l00129">129</a> of file <a class="el" href="a00554_source.html">stl_iterator_base_types.h</a>.</p> </div> </div> <a id="af9f36b7adb257959eef192b9282f1284"></a> <h2 class="memtitle"><span class="permalink"><a href="#af9f36b7adb257959eef192b9282f1284">◆ </a></span>value_type</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">typedef void <a class="el" href="a07672.html">std::iterator</a>< <a class="el" href="a07656.html">output_iterator_tag</a> , void , void , void , void >::<a class="el" href="a07672.html#af9f36b7adb257959eef192b9282f1284">value_type</a></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>The type "pointed to" by the iterator. </p> <p class="definition">Definition at line <a class="el" href="a00554_source.html#l00123">123</a> of file <a class="el" href="a00554_source.html">stl_iterator_base_types.h</a>.</p> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a69916dd7c180bcb5fb6874adaaacc08b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a69916dd7c180bcb5fb6874adaaacc08b">◆ </a></span>insert_iterator()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Container > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a07628.html">std::insert_iterator</a>< _Container >::<a class="el" href="a07628.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></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </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 class="definition">Definition at line <a class="el" href="a17142_source.html#l00657">657</a> of file <a class="el" href="a17142_source.html">bits/stl_iterator.h</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a1a406c868feb4c886b002870abeb8546"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1a406c868feb4c886b002870abeb8546">◆ </a></span>operator*()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Container > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a07628.html">insert_iterator</a>& <a class="el" href="a07628.html">std::insert_iterator</a>< _Container >::operator* </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Simply returns *this. </p> <p class="definition">Definition at line <a class="el" href="a17142_source.html#l00711">711</a> of file <a class="el" href="a17142_source.html">bits/stl_iterator.h</a>.</p> </div> </div> <a id="a66d30004d7402c9067fa8faadd7b8861"></a> <h2 class="memtitle"><span class="permalink"><a href="#a66d30004d7402c9067fa8faadd7b8861">◆ </a></span>operator++() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Container > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a07628.html">insert_iterator</a>& <a class="el" href="a07628.html">std::insert_iterator</a>< _Container >::operator++ </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Simply returns *this. (This iterator does not <em>move</em>.) </p> <p class="definition">Definition at line <a class="el" href="a17142_source.html#l00716">716</a> of file <a class="el" href="a17142_source.html">bits/stl_iterator.h</a>.</p> </div> </div> <a id="a1d81a713bb24ef57aba0ce6dba2a84f0"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1d81a713bb24ef57aba0ce6dba2a84f0">◆ </a></span>operator++() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Container > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a07628.html">insert_iterator</a>& <a class="el" href="a07628.html">std::insert_iterator</a>< _Container >::operator++ </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Simply returns *this. (This iterator does not <em>move</em>.) </p> <p class="definition">Definition at line <a class="el" href="a17142_source.html#l00721">721</a> of file <a class="el" href="a17142_source.html">bits/stl_iterator.h</a>.</p> </div> </div> <a id="a97b27e02a31008441dd0374c6a1021e4"></a> <h2 class="memtitle"><span class="permalink"><a href="#a97b27e02a31008441dd0374c6a1021e4">◆ </a></span>operator=()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Container > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a07628.html">insert_iterator</a>& <a class="el" href="a07628.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></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</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="section return"><dt>Returns</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"><div class="line"><span class="comment">// vector v contains A and Z</span></div><div class="line"></div><div class="line"><a class="code" href="a07628.html#a69916dd7c180bcb5fb6874adaaacc08b">insert_iterator</a> i (v, ++v.begin());</div><div class="line">i = 1;</div><div class="line">i = 2;</div><div class="line">i = 3;</div><div class="line"></div><div class="line"><span class="comment">// vector v contains A, 1, 2, 3, and Z</span></div></div><!-- fragment --> <p class="definition">Definition at line <a class="el" href="a17142_source.html#l00693">693</a> of file <a class="el" href="a17142_source.html">bits/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="a17142_source.html">bits/stl_iterator.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a01538.html">std</a></li><li class="navelem"><a class="el" href="a07628.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.8.15 </li> </ul> </div> </body> </html>