<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template extractor</title>
<link rel="stylesheet" href="../../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__id550789.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/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../accumulators/reference.html#header.boost.accumulators.framework.extractor_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="extractor/result_this_type_A1__id550789.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Struct template extractor">
<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="emphasis"><em>// 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>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Feature>
<span class="bold"><strong>struct</strong></span> <a class="link" href="extractor.html" title="Struct template extractor">extractor</a> {
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> <a class="link" href="extractor.html" title="Struct template extractor">extractor</a>< Feature > <a name="boost.accumulators.extractor.this_type"></a>this_type;
<span class="emphasis"><em>// member classes/structs/unions</em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> A1>
<span class="bold"><strong>struct</strong></span> <a class="link" href="extractor/result_this_type_A1__id550789.html" title="Struct template result<this_type(A1)>">result</a><this_type(A1)> {
};
<span class="emphasis"><em>// <a class="link" href="extractor.html#id550810-bb">public member functions</a></em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Arg1> <span class="type"><span class="emphasis"><em>unspecified</em></span></span> <a class="link" href="extractor.html#id550814-bb"><span class="bold"><strong>operator</strong></span>()</a>(Arg1 <span class="bold"><strong>const</strong></span> &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> AccumulatorSet, <span class="bold"><strong>typename</strong></span> A1>
<span class="type"><span class="emphasis"><em>unspecified</em></span></span> <a class="link" href="extractor.html#id550840-bb"><span class="bold"><strong>operator</strong></span>()</a>(AccumulatorSet <span class="bold"><strong>const</strong></span> &, A1 <span class="bold"><strong>const</strong></span> &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> AccumulatorSet, <span class="bold"><strong>typename</strong></span> A1, <span class="bold"><strong>typename</strong></span> A2, ... >
<span class="type"><span class="emphasis"><em>unspecified</em></span></span> <a class="link" href="extractor.html#id550881-bb"><span class="bold"><strong>operator</strong></span>()</a>(AccumulatorSet <span class="bold"><strong>const</strong></span> &, A1 <span class="bold"><strong>const</strong></span> &, A2 <span class="bold"><strong>const</strong></span> &,
...) ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id644962"></a><h2>Description</h2>
<p>Extracts the result associated with Feature from the specified accumulator_set. </p>
<div class="refsect2" title="extractor public member functions">
<a name="id644969"></a><h3>
<a name="id550810-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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Arg1> <span class="type"><span class="emphasis"><em>unspecified</em></span></span> <a name="id550814-bb"></a><span class="bold"><strong>operator</strong></span>()(Arg1 <span class="bold"><strong>const</strong></span> & arg1) <span class="bold"><strong>const</strong></span>;</pre>
<p>Extract the result associated with Feature from the accumulator set
</p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> AccumulatorSet, <span class="bold"><strong>typename</strong></span> A1>
<span class="type"><span class="emphasis"><em>unspecified</em></span></span> <a name="id550840-bb"></a><span class="bold"><strong>operator</strong></span>()(AccumulatorSet <span class="bold"><strong>const</strong></span> & acc, A1 <span class="bold"><strong>const</strong></span> & a1) <span class="bold"><strong>const</strong></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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> AccumulatorSet, <span class="bold"><strong>typename</strong></span> A1, <span class="bold"><strong>typename</strong></span> A2, ... >
<span class="type"><span class="emphasis"><em>unspecified</em></span></span> <a name="id550881-bb"></a><span class="bold"><strong>operator</strong></span>()(AccumulatorSet <span class="bold"><strong>const</strong></span> & acc, A1 <span class="bold"><strong>const</strong></span> & a1,
A2 <span class="bold"><strong>const</strong></span> & a2, ...) ;</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/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../accumulators/reference.html#header.boost.accumulators.framework.extractor_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="extractor/result_this_type_A1__id550789.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
