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=UTF-8"> 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 <boost/accumulators/accumulators_fwd.hpp>"> 10<link rel="prev" href="tag/value_tag.html" title="Struct template value_tag"> 11<link rel="next" href="as_feature.html" title="Struct template as_feature"> 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="tag/value_tag.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="as_feature.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 — 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: <<a class="link" href="../../accumulators/reference.html#header.boost.accumulators.accumulators_fwd_hpp" title="Header <boost/accumulators/accumulators_fwd.hpp>">boost/accumulators/accumulators_fwd.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</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> 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"><</span><span class="keyword">typename</span> A1<span class="special">></span> 39 <span class="keyword">explicit</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_5-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">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> 40 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A1<span class="special">></span> 41 <span class="keyword">explicit</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_6-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">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> 42 43 <span class="comment">// <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4-bb">public member functions</a></span> 44 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> UnaryFunction<span class="special">></span> <span class="keyword">void</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_1-bb"><span class="identifier">visit</span></a><span class="special">(</span><span class="identifier">UnaryFunction</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FilterPred<span class="special">,</span> <span class="keyword">typename</span> UnaryFunction<span class="special">></span> 46 <span class="keyword">void</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_2-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">&</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">void</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_3-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> 48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> apply<span class="special"><</span> <span class="identifier">Feature</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">&</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_4-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 49 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> apply<span class="special"><</span> <span class="identifier">Feature</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_5-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 50 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> <span class="keyword">void</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_6-bb"><span class="identifier">drop</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 51 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">></span> <span class="keyword">void</span> <a class="link" href="accumulator_set.html#id-1_3_2_6_2_3_1_1_1_4_7-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> 52<span class="special">}</span><span class="special">;</span></pre></div> 53<div class="refsect1"> 54<a name="id-1.3.2.6.2.3.10.4"></a><h2>Description</h2> 55<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> 56<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> 57<div class="refsect2"> 58<a name="id-1.3.2.6.2.3.10.4.4"></a><h3> 59<a name="boost.accumulators.accumulator_setconstruct-copy-destruct"></a><code class="computeroutput">accumulator_set</code> 60 public 61 construct/copy/destruct</h3> 62<div class="orderedlist"><ol class="orderedlist" type="1"> 63<li class="listitem"> 64<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A1<span class="special">></span> 65 <span class="keyword">explicit</span> <a name="id-1_3_2_6_2_3_1_1_1_5-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">&</span> a1<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre> 66<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</p> 67<p> 68</p> 69<div class="variablelist"><table border="0" class="variablelist compact"> 70<colgroup> 71<col align="left" valign="top"> 72<col> 73</colgroup> 74<tbody><tr> 75<td><p><span class="term">Parameters:</span></p></td> 76<td><div class="variablelist"><table border="0" class="variablelist compact"> 77<colgroup> 78<col align="left" valign="top"> 79<col> 80</colgroup> 81<tbody><tr> 82<td><p><span class="term"><code class="computeroutput">a1</code></span></p></td> 83<td><p>Optional named parameter to be passed to all the accumulators </p></td> 84</tr></tbody> 85</table></div></td> 86</tr></tbody> 87</table></div> 88</li> 89<li class="listitem"> 90<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A1<span class="special">></span> 91 <span class="keyword">explicit</span> <a name="id-1_3_2_6_2_3_1_1_1_6-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">&</span> a1<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span></pre> 92<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</p> 93<p> 94</p> 95<div class="variablelist"><table border="0" class="variablelist compact"> 96<colgroup> 97<col align="left" valign="top"> 98<col> 99</colgroup> 100<tbody><tr> 101<td><p><span class="term">Parameters:</span></p></td> 102<td><div class="variablelist"><table border="0" class="variablelist compact"> 103<colgroup> 104<col align="left" valign="top"> 105<col> 106</colgroup> 107<tbody><tr> 108<td><p><span class="term"><code class="computeroutput">a1</code></span></p></td> 109<td><p>Optional sample parameter to be passed to all the accumulators </p></td> 110</tr></tbody> 111</table></div></td> 112</tr></tbody> 113</table></div> 114</li> 115</ol></div> 116</div> 117<div class="refsect2"> 118<a name="id-1.3.2.6.2.3.10.4.5"></a><h3> 119<a name="id-1_3_2_6_2_3_1_1_1_4-bb"></a><code class="computeroutput">accumulator_set</code> public member functions</h3> 120<div class="orderedlist"><ol class="orderedlist" type="1"> 121<li class="listitem"> 122<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> UnaryFunction<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_2_6_2_3_1_1_1_4_1-bb"></a><span class="identifier">visit</span><span class="special">(</span><span class="identifier">UnaryFunction</span> <span class="keyword">const</span> <span class="special">&</span> func<span class="special">)</span><span class="special">;</span></pre> 123<p>Visitation 124</p> 125<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">Parameters:</span></p></td> 132<td><div class="variablelist"><table border="0" class="variablelist compact"> 133<colgroup> 134<col align="left" valign="top"> 135<col> 136</colgroup> 137<tbody><tr> 138<td><p><span class="term"><code class="computeroutput">func</code></span></p></td> 139<td><p>UnaryFunction which is invoked with each accumulator in turn. </p></td> 140</tr></tbody> 141</table></div></td> 142</tr></tbody> 143</table></div> 144</li> 145<li class="listitem"> 146<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FilterPred<span class="special">,</span> <span class="keyword">typename</span> UnaryFunction<span class="special">></span> 147 <span class="keyword">void</span> <a name="id-1_3_2_6_2_3_1_1_1_4_2-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">&</span> func<span class="special">)</span><span class="special">;</span></pre> 148<p>Conditional visitation 149</p> 150<div class="variablelist"><table border="0" class="variablelist compact"> 151<colgroup> 152<col align="left" valign="top"> 153<col> 154</colgroup> 155<tbody><tr> 156<td><p><span class="term">Parameters:</span></p></td> 157<td><div class="variablelist"><table border="0" class="variablelist compact"> 158<colgroup> 159<col align="left" valign="top"> 160<col> 161</colgroup> 162<tbody><tr> 163<td><p><span class="term"><code class="computeroutput">func</code></span></p></td> 164<td><p>UnaryFunction which is invoked with each accumulator in turn, provided the accumulator satisfies the MPL predicate FilterPred. </p></td> 165</tr></tbody> 166</table></div></td> 167</tr></tbody> 168</table></div> 169</li> 170<li class="listitem"> 171<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_2_6_2_3_1_1_1_4_3-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> 172<p>Accumulation 173</p> 174</li> 175<li class="listitem"> 176<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> apply<span class="special"><</span> <span class="identifier">Feature</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">&</span> <a name="id-1_3_2_6_2_3_1_1_1_4_4-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Extraction. </li> 177<li class="listitem"> 178<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> apply<span class="special"><</span> <span class="identifier">Feature</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id-1_3_2_6_2_3_1_1_1_4_5-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> 179<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> 180</li> 181<li class="listitem"> 182<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_2_6_2_3_1_1_1_4_6-bb"></a><span class="identifier">drop</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Drop. </li> 183<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">></span> 184 <span class="keyword">void</span> <a name="id-1_3_2_6_2_3_1_1_1_4_7-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></li> 185</ol></div> 186</div> 187</div> 188</div> 189<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 190<td align="left"></td> 191<td align="right"><div class="copyright-footer">Copyright © 2005, 2006 Eric Niebler<p> 192 Distributed under the Boost Software License, Version 1.0. (See accompanying 193 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>) 194 </p> 195</div></td> 196</tr></table> 197<hr> 198<div class="spirit-nav"> 199<a accesskey="p" href="tag/value_tag.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="as_feature.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 200</div> 201</body> 202</html> 203
