<!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::front_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('a00477.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::front_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::front_insert_iterator" --><!-- doxytag: inherits="iterator< output_iterator_tag, void, void, void, void >" -->
<p>Turns assignment into insertion.
<a href="a00477.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for std::front_insert_iterator< _Container >:</div>
<div class="dyncontent">
<div class="center"><img src="a02018.png" border="0" usemap="#std_1_1front__insert__iterator_3_01___container_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="std_1_1front__insert__iterator_3_01___container_01_4_inherit__map" id="std_1_1front__insert__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="a02019.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef _Container <a class="el" href="a00477.html#a4308a2935935721e29e7cd725be64007">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="a00477.html#af9af46e110258e56e4b6eb8a8b8d92c2">front_insert_iterator</a> (_Container &__x)
<li><a class="el" href="a00477.html">front_insert_iterator</a> & <a class="el" href="a00477.html#a1686a970fd21798542dd32e3c2208b95">operator*</a> ()
<li><a class="el" href="a00477.html">front_insert_iterator</a> & <a class="el" href="a00477.html#aac63c27293526bf0b0c4d4a2472ba785">operator++</a> ()
<li><a class="el" href="a00477.html">front_insert_iterator</a> <a class="el" href="a00477.html#a0bb8e39402c65287d891388eaea27c8b">operator++</a> (int)
<li><a class="el" href="a00477.html">front_insert_iterator</a> & <a class="el" href="a00477.html#ad88a7eabbaf51cfa7c8152e1c27d226f">operator=</a> (const typename _Container::value_type &__value)
<li><a class="anchor" id="acabefe4be5a43be562f5bd9a7642028e"></a><!-- doxytag: member="std::front_insert_iterator::operator=" ref="acabefe4be5a43be562f5bd9a7642028e" args="(typename _Container::value_type &&__value)" -->
<a class="el" href="a00477.html">front_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="a782ca4c1630ff946d88b5e97c2490f06"></a><!-- doxytag: member="std::front_insert_iterator::container" ref="a782ca4c1630ff946d88b5e97c2490f06" args="" -->
_Container * <b>container</b>
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename _Container><br/>
class std::front_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 prepends it to the container using push_front.</p>
<p>Tip: Using the front_inserter function to create these iterators can save typing. </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00487">487</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="a4308a2935935721e29e7cd725be64007"></a><!-- doxytag: member="std::front_insert_iterator::container_type" ref="a4308a2935935721e29e7cd725be64007" 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="a00477.html">std::front_insert_iterator</a>< _Container >::<a class="el" href="a00477.html#a4308a2935935721e29e7cd725be64007">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#l00495">495</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::front_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::front_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::front_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::front_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::front_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="af9af46e110258e56e4b6eb8a8b8d92c2"></a><!-- doxytag: member="std::front_insert_iterator::front_insert_iterator" ref="af9af46e110258e56e4b6eb8a8b8d92c2" args="(_Container &__x)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Container > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00477.html">std::front_insert_iterator</a>< _Container >::<a class="el" href="a00477.html">front_insert_iterator</a> </td>
<td>(</td>
<td class="paramtype">_Container & </td>
<td class="paramname"><em>__x</em></td><td>)</td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The only way to create this iterator is with a container. </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00498">498</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="a1686a970fd21798542dd32e3c2208b95"></a><!-- doxytag: member="std::front_insert_iterator::operator*" ref="a1686a970fd21798542dd32e3c2208b95" 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="a00477.html">front_insert_iterator</a>& <a class="el" href="a00477.html">std::front_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#l00536">536</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0bb8e39402c65287d891388eaea27c8b"></a><!-- doxytag: member="std::front_insert_iterator::operator++" ref="a0bb8e39402c65287d891388eaea27c8b" 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="a00477.html">front_insert_iterator</a> <a class="el" href="a00477.html">std::front_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#l00546">546</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="aac63c27293526bf0b0c4d4a2472ba785"></a><!-- doxytag: member="std::front_insert_iterator::operator++" ref="aac63c27293526bf0b0c4d4a2472ba785" 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="a00477.html">front_insert_iterator</a>& <a class="el" href="a00477.html">std::front_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#l00541">541</a> of file <a class="el" href="a01052_source.html">stl_iterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad88a7eabbaf51cfa7c8152e1c27d226f"></a><!-- doxytag: member="std::front_insert_iterator::operator=" ref="ad88a7eabbaf51cfa7c8152e1c27d226f" 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="a00477.html">front_insert_iterator</a>& <a class="el" href="a00477.html">std::front_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 doesn't really have a <em>position</em> in the container (you can think of the position as being permanently at the front, if you like). Assigning a value to the iterator will always prepend the value to the front of the container. </p>
<p>Definition at line <a class="el" href="a01052_source.html#l00520">520</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="a00477.html">front_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>
