• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 extractor</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="droppable_accumulator_base.html" title="Struct template droppable_accumulator_base">
11<link rel="next" href="feature_of.html" title="Struct template feature_of">
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="droppable_accumulator_base.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="feature_of.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.accumulators.extractor"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Struct template extractor</span></h2>
30<p>boost::accumulators::extractor — Extracts the result associated with Feature from the specified <a class="link" href="accumulator_set.html" title="Struct template accumulator_set">accumulator_set</a>. </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> Feature<span class="special">&gt;</span>
36<span class="keyword">struct</span> <a class="link" href="extractor.html" title="Struct template extractor">extractor</a> <span class="special">{</span>
37
38  <span class="comment">// <a class="link" href="extractor.html#id-1_3_2_6_2_3_1_1_7_3-bb">public member functions</a></span>
39  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Arg1<span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#id-1_3_2_6_2_3_1_1_7_3_1-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">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
40  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> AccumulatorSet<span class="special">,</span> <span class="keyword">typename</span> A1<span class="special">&gt;</span>
41    <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#id-1_3_2_6_2_3_1_1_7_3_2-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">&amp;</span><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="keyword">const</span><span class="special">;</span>
42  <span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
43    <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#id-1_3_2_6_2_3_1_1_7_3_3-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">&amp;</span><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="identifier">A2</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
44                           <span class="special">...</span><span class="special">)</span><span class="special">;</span>
45<span class="special">}</span><span class="special">;</span></pre></div>
46<div class="refsect1">
47<a name="id-1.3.2.6.2.3.16.4"></a><h2>Description</h2>
48<div class="refsect2">
49<a name="id-1.3.2.6.2.3.16.4.2"></a><h3>
50<a name="id-1_3_2_6_2_3_1_1_7_3-bb"></a><code class="computeroutput">extractor</code> public member functions</h3>
51<div class="orderedlist"><ol class="orderedlist" type="1">
52<li class="listitem">
53<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Arg1<span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id-1_3_2_6_2_3_1_1_7_3_1-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">&amp;</span> arg1<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
54<p>Extract the result associated with Feature from the accumulator set
55</p>
56</li>
57<li class="listitem">
58<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> AccumulatorSet<span class="special">,</span> <span class="keyword">typename</span> A1<span class="special">&gt;</span>
59  <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id-1_3_2_6_2_3_1_1_7_3_2-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">&amp;</span> acc<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="keyword">const</span><span class="special">;</span></pre>
60<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</p>
61<p>
62</p>
63<div class="variablelist"><table border="0" class="variablelist compact">
64<colgroup>
65<col align="left" valign="top">
66<col>
67</colgroup>
68<tbody><tr>
69<td><p><span class="term">Parameters:</span></p></td>
70<td><div class="variablelist"><table border="0" class="variablelist compact">
71<colgroup>
72<col align="left" valign="top">
73<col>
74</colgroup>
75<tbody><tr>
76<td><p><span class="term"><code class="computeroutput">a1</code></span></p></td>
77<td><p>Optional named parameter to be passed to the accumulator's result() function. </p></td>
78</tr></tbody>
79</table></div></td>
80</tr></tbody>
81</table></div>
82</li>
83<li class="listitem">
84<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
85  <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id-1_3_2_6_2_3_1_1_7_3_3-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">&amp;</span> acc<span class="special">,</span> <span class="identifier">A1</span> <span class="keyword">const</span> <span class="special">&amp;</span> a1<span class="special">,</span>
86                         <span class="identifier">A2</span> <span class="keyword">const</span> <span class="special">&amp;</span> a2<span class="special">,</span> <span class="special">...</span><span class="special">)</span><span class="special">;</span></pre>
87<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
88</li>
89</ol></div>
90</div>
91</div>
92</div>
93<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
94<td align="left"></td>
95<td align="right"><div class="copyright-footer">Copyright © 2005, 2006 Eric Niebler<p>
96        Distributed under the Boost Software License, Version 1.0. (See accompanying
97        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>)
98      </p>
99</div></td>
100</tr></table>
101<hr>
102<div class="spirit-nav">
103<a accesskey="p" href="droppable_accumulator_base.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="feature_of.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
104</div>
105</body>
106</html>
107