doc/html/boost/accumulators/accumulator_set.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct template accumulator_set</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../accumulators/reference.html#header.boost.accumulators.accumulators_fwd_hpp" title="Header &lt;boost/accumulators/accumulators_fwd.hpp&gt;">
  10 <link rel="prev" href="with_cached_result.html" title="Struct template with_cached_result">
  11 <link rel="next" href="extractor.html" title="Struct template extractor">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="with_cached_result.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../accumulators/reference.html#header.boost.accumulators.accumulators_fwd_hpp"><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="extractor.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.accumulators.accumulator_set"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template accumulator_set</span></h2>
  30 <p>boost::accumulators::accumulator_set &#8212; A set of accumulators. </p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../accumulators/reference.html#header.boost.accumulators.accumulators_fwd_hpp" title="Header &lt;boost/accumulators/accumulators_fwd.hpp&gt;">boost/accumulators/accumulators_fwd.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Sample<span class="special">,</span> <span class="keyword">typename</span> Features<span class="special">,</span> <span class="keyword">typename</span> Weight <span class="special">=</span> <span class="keyword">void</span><span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="accumulator_set.html" title="Struct template accumulator_set">accumulator_set</a> <span class="special">{</span>
  37   <span class="comment">// <a class="link" href="accumulator_set.html#boost.accumulators.accumulator_setconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> A1<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="accumulator_set.html#idp362196848-bb"><span class="identifier">accumulator_set</span></a><span class="special">(</span><span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="accumulator_set.html#idp362178320-bb">public member functions</a></span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnaryFunction<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="accumulator_set.html#idp362178880-bb"><span class="identifier">visit</span></a><span class="special">(</span><span class="identifier">UnaryFunction</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FilterPred<span class="special">,</span> <span class="keyword">typename</span> UnaryFunction<span class="special">&gt;</span>
  43     <span class="keyword">void</span> <a class="link" href="accumulator_set.html#idp362182064-bb"><span class="identifier">visit_if</span></a><span class="special">(</span><span class="identifier">UnaryFunction</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">void</span> <a class="link" href="accumulator_set.html#idp362185968-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> A1<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="accumulator_set.html#idp362187232-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Feature<span class="special">&gt;</span> apply<span class="special">&lt;</span> <span class="identifier">Feature</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&amp;</span> <a class="link" href="accumulator_set.html#idp362189616-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Feature<span class="special">&gt;</span> apply<span class="special">&lt;</span> <span class="identifier">Feature</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="accumulator_set.html#idp362191888-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Feature<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="accumulator_set.html#idp362194704-bb"><span class="identifier">drop</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idp105035712"></a><h2>Description</h2>
  52 <p><a class="link" href="accumulator_set.html" title="Struct template accumulator_set">accumulator_set</a> resolves the dependencies between features and ensures that the accumulators in the set are updated in the proper order.</p>
  53 <p>acccumulator_set provides a general mechanism to visit the accumulators in the set in order, with or without a filter. You can also fetch a reference to an accumulator that corresponds to a feature. </p>
  54 <div class="refsect2">
  55 <a name="idp105037744"></a><h3>
  56 <a name="boost.accumulators.accumulator_setconstruct-copy-destruct"></a><code class="computeroutput">accumulator_set</code>
  57         public
  58        construct/copy/destruct</h3>
  59 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  60 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> A1<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idp362196848-bb"></a><span class="identifier">accumulator_set</span><span class="special">(</span><span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&amp;</span> a1<span class="special">)</span><span class="special">;</span></pre>
  61 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</p>
  62 <p>
  63 </p>
  64 <div class="variablelist"><table border="0" class="variablelist compact">
  65 <colgroup>
  66 <col align="left" valign="top">
  67 <col>
  68 </colgroup>
  69 <tbody><tr>
  70 <td><p><span class="term">Parameters:</span></p></td>
  71 <td><div class="variablelist"><table border="0" class="variablelist compact">
  72 <colgroup>
  73 <col align="left" valign="top">
  74 <col>
  75 </colgroup>
  76 <tbody><tr>
  77 <td><p><span class="term"><code class="computeroutput">a1</code></span></p></td>
  78 <td><p>Optional named parameter to be passed to all the accumulators </p></td>
  79 </tr></tbody>
  80 </table></div></td>
  81 </tr></tbody>
  82 </table></div>
  83 </li></ol></div>
  84 </div>
  85 <div class="refsect2">
  86 <a name="idp105052416"></a><h3>
  87 <a name="idp362178320-bb"></a><code class="computeroutput">accumulator_set</code> public member functions</h3>
  88 <div class="orderedlist"><ol class="orderedlist" type="1">
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnaryFunction<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp362178880-bb"></a><span class="identifier">visit</span><span class="special">(</span><span class="identifier">UnaryFunction</span> <span class="keyword">const</span> <span class="special">&amp;</span> func<span class="special">)</span><span class="special">;</span></pre>
  91 <p>Visitation
  92 </p>
  93 <div class="variablelist"><table border="0" class="variablelist compact">
  94 <colgroup>
  95 <col align="left" valign="top">
  96 <col>
  97 </colgroup>
  98 <tbody><tr>
  99 <td><p><span class="term">Parameters:</span></p></td>
 100 <td><div class="variablelist"><table border="0" class="variablelist compact">
 101 <colgroup>
 102 <col align="left" valign="top">
 103 <col>
 104 </colgroup>
 105 <tbody><tr>
 106 <td><p><span class="term"><code class="computeroutput">func</code></span></p></td>
 107 <td><p>UnaryFunction which is invoked with each accumulator in turn. </p></td>
 108 </tr></tbody>
 109 </table></div></td>
 110 </tr></tbody>
 111 </table></div>
 112 </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FilterPred<span class="special">,</span> <span class="keyword">typename</span> UnaryFunction<span class="special">&gt;</span>
 115   <span class="keyword">void</span> <a name="idp362182064-bb"></a><span class="identifier">visit_if</span><span class="special">(</span><span class="identifier">UnaryFunction</span> <span class="keyword">const</span> <span class="special">&amp;</span> func<span class="special">)</span><span class="special">;</span></pre>
 116 <p>Conditional visitation
 117 </p>
 118 <div class="variablelist"><table border="0" class="variablelist compact">
 119 <colgroup>
 120 <col align="left" valign="top">
 121 <col>
 122 </colgroup>
 123 <tbody><tr>
 124 <td><p><span class="term">Parameters:</span></p></td>
 125 <td><div class="variablelist"><table border="0" class="variablelist compact">
 126 <colgroup>
 127 <col align="left" valign="top">
 128 <col>
 129 </colgroup>
 130 <tbody><tr>
 131 <td><p><span class="term"><code class="computeroutput">func</code></span></p></td>
 132 <td><p>UnaryFunction which is invoked with each accumulator in turn, provided the accumulator satisfies the MPL predicate FilterPred. </p></td>
 133 </tr></tbody>
 134 </table></div></td>
 135 </tr></tbody>
 136 </table></div>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="keyword">void</span> <a name="idp362185968-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 140 <p>Accumulation
 141 </p>
 142 </li>
 143 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> A1<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp362187232-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&amp;</span> a1<span class="special">)</span><span class="special">;</span></pre></li>
 144 <li class="listitem">
 145 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Feature<span class="special">&gt;</span> apply<span class="special">&lt;</span> <span class="identifier">Feature</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&amp;</span> <a name="idp362189616-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Extraction. </li>
 146 <li class="listitem">
 147 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Feature<span class="special">&gt;</span> apply<span class="special">&lt;</span> <span class="identifier">Feature</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp362191888-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 148 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 149 </li>
 150 <li class="listitem">
 151 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Feature<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp362194704-bb"></a><span class="identifier">drop</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Drop. </li>
 152 </ol></div>
 153 </div>
 154 </div>
 155 </div>
 156 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 157 <td align="left"></td>
 158 <td align="right"><div class="copyright-footer">Copyright &#169; 2005, 2006 Eric Niebler<p>
 159         Distributed under the Boost Software License, Version 1.0. (See accompanying
 160         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>)
 161       </p>
 162 </div></td>
 163 </tr></table>
 164 <hr>
 165 <div class="spirit-nav">
 166 <a accesskey="p" href="with_cached_result.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../accumulators/reference.html#header.boost.accumulators.accumulators_fwd_hpp"><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="extractor.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 167 </div>
 168 </body>
 169 </html>