3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class template insert_iterator</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../index.html" title="Chapter 1. Boost.Icl">
8 <link rel="up" href="../../header/boost/icl/iterator_hpp.html" title="Header <boost/icl/iterator.hpp>">
9 <link rel="prev" href="add_iterator.html" title="Class template add_iterator">
10 <link rel="next" href="adder.html" title="Function template adder">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="add_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/icl/iterator_hpp.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adder.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="boost.icl.insert_iterator"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class template insert_iterator</span></h2>
29 <p>boost::icl::insert_iterator — Performes an insertion using a container's memberfunction add, when operator= is called. </p>
31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../header/boost/icl/iterator_hpp.html" title="Header <boost/icl/iterator.hpp>">boost/icl/iterator.hpp</a>>
34 </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ContainerT<span class="special">></span>
35 <span class="keyword">class</span> <a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">{</span>
36 <span class="keyword">public</span><span class="special">:</span>
37 <span class="comment">// types</span>
38 <span class="keyword">typedef</span> <span class="identifier">ContainerT</span> <a name="boost.icl.insert_iterator.container_type"></a><span class="identifier">container_type</span><span class="special">;</span> <span class="comment">// The container's type. </span>
39 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">output_iterator_tag</span> <a name="boost.icl.insert_iterator.iterator_category"></a><span class="identifier">iterator_category</span><span class="special">;</span>
40 <span class="keyword">typedef</span> <span class="keyword">void</span> <a name="boost.icl.insert_iterator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
41 <span class="keyword">typedef</span> <span class="keyword">void</span> <a name="boost.icl.insert_iterator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
42 <span class="keyword">typedef</span> <span class="keyword">void</span> <a name="boost.icl.insert_iterator.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
43 <span class="keyword">typedef</span> <span class="keyword">void</span> <a name="boost.icl.insert_iterator.reference"></a><span class="identifier">reference</span><span class="special">;</span>
45 <span class="comment">// <a class="link" href="insert_iterator.html#boost.icl.insert_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
46 <a class="link" href="insert_iterator.html#idm45066488714048-bb"><span class="identifier">insert_iterator</span></a><span class="special">(</span><span class="identifier">ContainerT</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ContainerT</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span>
47 <a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a class="link" href="insert_iterator.html#idm45066488711152-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">ContainerT</span><span class="special">::</span><span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span>
49 <span class="comment">// <a class="link" href="insert_iterator.html#idm45066488718864-bb">public member functions</a></span>
50 <a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a class="link" href="insert_iterator.html#idm45066488718304-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
51 <a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a class="link" href="insert_iterator.html#idm45066488717168-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
52 <a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a class="link" href="insert_iterator.html#idm45066488716032-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
53 <span class="special">}</span><span class="special">;</span></pre></div>
54 <div class="refsect1">
55 <a name="idm46241556498560"></a><h2>Description</h2>
56 <div class="refsect2">
57 <a name="idm46241556498144"></a><h3>
58 <a name="boost.icl.insert_iteratorconstruct-copy-destruct"></a><code class="computeroutput">insert_iterator</code>
60 construct/copy/destruct</h3>
61 <div class="orderedlist"><ol class="orderedlist" type="1">
63 <pre class="literallayout"><a name="idm45066488714048-bb"></a><span class="identifier">insert_iterator</span><span class="special">(</span><span class="identifier">ContainerT</span> <span class="special">&</span> cont<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ContainerT</span><span class="special">::</span><span class="identifier">iterator</span> iter<span class="special">)</span><span class="special">;</span></pre>
64 <p>An <code class="computeroutput"><a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a></code> is constructed with a container and a position that has to be maintained. </p>
67 <pre class="literallayout"><a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a name="idm45066488711152-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">ContainerT</span><span class="special">::</span><span class="identifier">const_reference</span> value<span class="special">)</span><span class="special">;</span></pre>
68 <p>This assignment operator adds the <code class="computeroutput">value</code> before the current position. It maintains it's position by incrementing after addition. </p>
72 <div class="refsect2">
73 <a name="idm46241556476848"></a><h3>
74 <a name="idm45066488718864-bb"></a><code class="computeroutput">insert_iterator</code> public member functions</h3>
75 <div class="orderedlist"><ol class="orderedlist" type="1">
76 <li class="listitem"><pre class="literallayout"><a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a name="idm45066488718304-bb"></a><span class="keyword">operator</span> <span class="special">*</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
77 <li class="listitem"><pre class="literallayout"><a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a name="idm45066488717168-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
78 <li class="listitem"><pre class="literallayout"><a class="link" href="insert_iterator.html" title="Class template insert_iterator">insert_iterator</a> <span class="special">&</span> <a name="idm45066488716032-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre></li>
83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
84 <td align="left"></td>
85 <td align="right"><div class="copyright-footer">Copyright © 2007-2010 Joachim
86 Faulhaber<br>Copyright © 1999-2006 Cortex Software
88 Distributed under the Boost Software License, Version 1.0. (See accompanying
89 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
94 <div class="spirit-nav">
95 <a accesskey="p" href="add_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/icl/iterator_hpp.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="adder.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>