<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Struct template extractor</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../accumulators/reference.html#header.boost.accumulators.framework.extractor_hpp" title="Header <boost/accumulators/framework/extractor.hpp>"> <link rel="prev" href="depends_on.html" title="Struct template depends_on"> <link rel="next" href="extractor/result_this_type_A1__id556395.html" title="Struct template result<this_type(A1)>"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="depends_on.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../accumulators/reference.html#header.boost.accumulators.framework.extractor_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/result_this_type_A1__id556395.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.accumulators.extractor"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Struct template extractor</span></h2> <p>boost::accumulators::extractor</p> </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <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.framework.extractor_hpp" title="Header <boost/accumulators/framework/extractor.hpp>">boost/accumulators/framework/extractor.hpp</a>> </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Feature<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="extractor.html" title="Struct template extractor">extractor</a> <span class="special">{</span> <span class="comment">// types</span> <span class="keyword">typedef</span> <a class="link" href="extractor.html" title="Struct template extractor">extractor</a><span class="special"><</span> <span class="identifier">Feature</span> <span class="special">></span> <a name="boost.accumulators.extractor.this_type"></a><span class="identifier">this_type</span><span class="special">;</span> <span class="comment">// member classes/structs/unions</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> A1<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="extractor/result_this_type_A1__id556395.html" title="Struct template result<this_type(A1)>">result</a><span class="special"><</span><span class="identifier">this_type</span><span class="special">(</span><span class="identifier">A1</span><span class="special">)</span><span class="special">></span> <span class="special">{</span> <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="extractor.html#id556416-bb">public member functions</a></span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Arg1<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#id556420-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Arg1</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> AccumulatorSet<span class="special">,</span> <span class="keyword">typename</span> A1<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#id556446-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">AccumulatorSet</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> AccumulatorSet<span class="special">,</span> <span class="keyword">typename</span> A1<span class="special">,</span> <span class="keyword">typename</span> A2<span class="special">,</span> <span class="special">...</span> <span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#id556488-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">AccumulatorSet</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">A2</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="special">...</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> <a name="id858435"></a><h2>Description</h2> <p>Extracts the result associated with Feature from the specified accumulator_set. </p> <div class="refsect2"> <a name="id858442"></a><h3> <a name="id556416-bb"></a><code class="computeroutput">extractor</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Arg1<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id556420-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Arg1</span> <span class="keyword">const</span> <span class="special">&</span> arg1<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Extract the result associated with Feature from the accumulator set </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> AccumulatorSet<span class="special">,</span> <span class="keyword">typename</span> A1<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id556446-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">AccumulatorSet</span> <span class="keyword">const</span> <span class="special">&</span> acc<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="keyword">const</span><span class="special">;</span></pre> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term">Parameters:</span></p></td> <td><div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><code class="computeroutput">a1</code></span></p></td> <td><p>Optional named parameter to be passed to the accumulator's result() function. </p></td> </tr></tbody> </table></div></td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> AccumulatorSet<span class="special">,</span> <span class="keyword">typename</span> A1<span class="special">,</span> <span class="keyword">typename</span> A2<span class="special">,</span> <span class="special">...</span> <span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id556488-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">AccumulatorSet</span> <span class="keyword">const</span> <span class="special">&</span> acc<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="identifier">A2</span> <span class="keyword">const</span> <span class="special">&</span> a2<span class="special">,</span> <span class="special">...</span><span class="special">)</span><span class="special">;</span></pre> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> </li> </ol></div> </div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2005, 2006 Eric Niebler<p> Distributed under the Boost Software License, Version 1.0. (See accompanying 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>) </p> </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="depends_on.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../accumulators/reference.html#header.boost.accumulators.framework.extractor_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/result_this_type_A1__id556395.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>