boost_mpl/doc/refmanual/inserters-inserter.html

<?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" />
<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
<title>The MPL Reference Manual: inserter</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="./front-inserter.html" class="navigation-link">Prev</a>&nbsp;<a href="./iteration-algorithms.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./front-inserter.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./inserters.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</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="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./inserters.html" class="navigation-link">Inserters</a> / <a href="./inserters-inserter.html" class="navigation-link">inserter</a></td>
</tr></table><div class="header-separator"></div>
<div class="section" id="inserters-inserter">
<h1><a class="toc-backref" href="./inserters.html#id395" name="inserters-inserter">inserter</a></h1>
<a class="target" id="id87" name="id87"></a><div class="section" id="inserters-synopsis">
<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
<pre class="literal-block">
template&lt;
      typename State
    , typename Operation
    &gt;
struct <a href="./inserter.html" class="identifier">inserter</a>
{
    typedef State state;
    typedef Operation operation;
};
</pre>
</div>
<div class="section" id="inserters-description">
<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
<p>A general-purpose model of the <a class="reference" href="./inserter.html">Inserter</a> concept.</p>
</div>
<div class="section" id="inserters-header">
<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
<pre class="literal-block">
#include &lt;<a href="../../../../boost/mpl/inserter.hpp" class="header">boost/mpl/inserter.hpp</a>&gt;
</pre>
</div>
<div class="section" id="inserters-model-of">
<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
<p><a class="reference" href="./inserter.html">Inserter</a></p>
</div>
<div class="section" id="inserters-parameters">
<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
<table border="1" class="table">
<colgroup>
<col width="19%" />
<col width="38%" />
<col width="43%" />
</colgroup>
<thead valign="bottom">
<tr><th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="literal"><span class="pre">State</span></tt></td>
<td>Any type</td>
<td>A initial state.</td>
</tr>
<tr><td><tt class="literal"><span class="pre">Operation</span></tt></td>
<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
<td>An output operation.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="inserters-expression-semantics">
<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
<p>The semantics of an expression are defined only
where they differ from, or are not defined in <a class="reference" href="./inserter.html">Inserter</a>.</p>
<p>For any binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a> <tt class="literal"><span class="pre">op</span></tt> and arbitrary type <tt class="literal"><span class="pre">state</span></tt>:</p>
<table border="1" class="table">
<colgroup>
<col width="39%" />
<col width="61%" />
</colgroup>
<thead valign="bottom">
<tr><th>Expression</th>
<th>Semantics</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="literal"><span class="pre"><a href="./inserter.html" class="identifier">inserter</a>&lt;op,state&gt;</span></tt></td>
<td>An <a class="reference" href="./inserter.html">Inserter</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="inserters-complexity">
<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
<p>Amortized constant time.</p>
</div>
<div class="section" id="inserters-example">
<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
<pre class="literal-block">
template&lt; typename N &gt; struct is_odd : <a href="./bool.html" class="identifier">bool_</a>&lt; ( N::value % 2 ) &gt; {};

typedef <a href="./copy.html" class="identifier">copy</a>&lt;
      <a href="./range-c.html" class="identifier">range_c</a>&lt;int,0,10&gt;
    , <a href="./inserter.html" class="identifier">inserter</a>&lt; // a filtering '<a href="./push-back.html" class="identifier">push_back</a>' <a href="./inserter.html" class="identifier">inserter</a>
          <a href="./vector.html" class="identifier">vector</a>&lt;&gt;
        , <a href="./if.html" class="identifier">if_</a>&lt; is_odd&lt;_2&gt;, <a href="./push-back.html" class="identifier">push_back</a>&lt;_1,_2&gt;, _1 &gt;
        &gt;
    &gt;::type odds;
   
<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>&lt; odds, <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,1,3,5,7,9&gt;, <a href="./equal-to.html" class="identifier">equal_to</a>&lt;_,_&gt; > ));
</pre>
</div>
<div class="section" id="inserters-see-also">
<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
<p><a class="reference" href="./algorithms.html">Algorithms</a>, <a class="reference" href="./inserter.html">Inserter</a>, <a class="reference" href="./reversible-algorithm.html">Reversible Algorithm</a>, <a class="refentry reference" href="./front-inserter.html"><tt class="refentry literal"><span class="pre">front_inserter</span></tt></a>, <a class="refentry reference" href="./back-inserter.html"><tt class="refentry literal"><span class="pre">back_inserter</span></tt></a></p>
<!-- modtime: November 15, 2004 06:46:20 +0000 -->
</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="./front-inserter.html" class="navigation-link">Prev</a>&nbsp;<a href="./iteration-algorithms.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./front-inserter.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./inserters.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
</tr></table></body>
</html>