diff options
Diffstat (limited to 'doc/html/boost/accumulators/extractor.html')
-rw-r--r-- | doc/html/boost/accumulators/extractor.html | 57 |
1 files changed, 28 insertions, 29 deletions
diff --git a/doc/html/boost/accumulators/extractor.html b/doc/html/boost/accumulators/extractor.html index 41eab7b500..e40c8b4481 100644 --- a/doc/html/boost/accumulators/extractor.html +++ b/doc/html/boost/accumulators/extractor.html @@ -3,11 +3,11 @@ <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.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <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__id561565.html" title="Struct template result<this_type(A1)>"> +<link rel="up" href="../../accumulators/reference.html#header.boost.accumulators.accumulators_fwd_hpp" title="Header <boost/accumulators/accumulators_fwd.hpp>"> +<link rel="prev" href="accumulator_set.html" title="Struct template accumulator_set"> +<link rel="next" href="feature_of.html" title="Struct template feature_of"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,58 +20,57 @@ </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__id561565.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="accumulator_set.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> </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> +<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> </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>> +<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>> </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__id561565.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#id561586-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#id561590-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="comment">// <a class="link" href="extractor.html#idp65447920-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#idp65448480-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#id561616-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="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#idp65451728-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#id561658-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="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="extractor.html#idp65457072-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="id868760"></a><h2>Description</h2> -<p>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> +<a name="idp99505360"></a><h2>Description</h2> <div class="refsect2"> -<a name="id868775"></a><h3> -<a name="id561586-bb"></a><code class="computeroutput">extractor</code> public member functions</h3> +<a name="idp99505776"></a><h3> +<a name="idp65447920-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="id561590-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> +<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="idp65448480-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="id561616-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. + <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idp65451728-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> +<p> </p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Parameters:</span></p></td> -<td><div class="variablelist"><table border="0"> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <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> @@ -82,7 +81,7 @@ </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="id561658-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="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idp65457072-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> @@ -100,7 +99,7 @@ </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__id561565.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="accumulator_set.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> </div> </body> </html> |