diff options
Diffstat (limited to 'doc/html/boost/accumulators/impl/density_impl.html')
| -rw-r--r-- | doc/html/boost/accumulators/impl/density_impl.html | 49 |
1 files changed, 23 insertions, 26 deletions
diff --git a/doc/html/boost/accumulators/impl/density_impl.html b/doc/html/boost/accumulators/impl/density_impl.html index c431d3cf7e..0287dbe8db 100644 --- a/doc/html/boost/accumulators/impl/density_impl.html +++ b/doc/html/boost/accumulators/impl/density_impl.html @@ -3,11 +3,11 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Struct template density_impl</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.statistics.density_hpp" title="Header <boost/accumulators/statistics/density.hpp>"> -<link rel="prev" href="../extract/density.html" title="Global density"> -<link rel="next" href="../tag/density.html" title="Struct density"> +<link rel="up" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_fwd_hpp" title="Header <boost/accumulators/statistics_fwd.hpp>"> +<link rel="prev" href="covariance_impl.html" title="Struct template covariance_impl"> +<link rel="next" href="error_of_mean_impl.html" title="Struct template error_of_mean_impl"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../extract/density.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.density_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="../tag/density.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="covariance_impl.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_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="error_of_mean_impl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.accumulators.impl.density_impl"></a><div class="titlepage"></div> @@ -29,46 +29,43 @@ <p>boost::accumulators::impl::density_impl — Histogram density estimator. </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.statistics.density_hpp" title="Header <boost/accumulators/statistics/density.hpp>">boost/accumulators/statistics/density.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.statistics_fwd_hpp" title="Header <boost/accumulators/statistics_fwd.hpp>">boost/accumulators/statistics_fwd.hpp</a>> </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Sample<span class="special">></span> -<span class="keyword">struct</span> <a class="link" href="density_impl.html" title="Struct template density_impl">density_impl</a> <span class="special">{</span> - <span class="comment">// types</span> - <span class="keyword">typedef</span> <span class="identifier">numeric</span><span class="special">::</span><span class="identifier">functional</span><span class="special">::</span><span class="identifier">average</span><span class="special"><</span> <span class="identifier">Sample</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.accumulators.impl.density_impl.float_type"></a><span class="identifier">float_type</span><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">float_type</span><span class="special">,</span> <span class="identifier">float_type</span> <span class="special">></span> <span class="special">></span> <a name="boost.accumulators.impl.density_impl.histogram_type"></a><span class="identifier">histogram_type</span><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">float_type</span> <span class="special">></span> <a name="boost.accumulators.impl.density_impl.array_type"></a><span class="identifier">array_type</span><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">iterator_range</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">histogram_type</span><span class="special">::</span><span class="identifier">iterator</span> <span class="special">></span> <a name="boost.accumulators.impl.density_impl.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> - +<span class="keyword">struct</span> <a class="link" href="density_impl.html" title="Struct template density_impl">density_impl</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">accumulator_base</span> <span class="special">{</span> <span class="comment">// <a class="link" href="density_impl.html#boost.accumulators.impl.density_implconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <a class="link" href="density_impl.html#id562645-bb"><span class="identifier">density_impl</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <a class="link" href="density_impl.html#idp66728448-bb"><span class="identifier">density_impl</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="density_impl.html#id562594-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="keyword">void</span> <a class="link" href="density_impl.html#id562597-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="density_impl.html#id562617-bb"><span class="identifier">result</span></a><span class="special">(</span><span class="identifier">Args</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="density_impl.html#idp66721808-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="keyword">void</span> <a class="link" href="density_impl.html#idp66722368-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="density_impl.html#idp66724752-bb"><span class="identifier">result</span></a><span class="special">(</span><span class="identifier">Args</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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id876722"></a><h2>Description</h2> +<a name="idp109302624"></a><h2>Description</h2> <p>The histogram density estimator returns a histogram of the sample distribution. The positions and sizes of the bins are determined using a specifiable number of cached samples (cache_size). The range between the minimum and the maximum of the cached samples is subdivided into a specifiable number of bins (num_bins) of same size. Additionally, an under- and an overflow bin is added to capture future under- and overflow samples. Once the bins are determined, the cached samples and all subsequent samples are added to the correct bins. At the end, a range of std::pair is return, where each pair contains the position of the bin (lower bound) and the samples count (normalized with the total number of samples).</p> <p> </p> <div class="refsect2"> -<a name="id876729"></a><h3> +<a name="idp83614160"></a><h3> <a name="boost.accumulators.impl.density_implconstruct-copy-destruct"></a><code class="computeroutput">density_impl</code> public construct/copy/destruct</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> Args<span class="special">></span> <a name="id562645-bb"></a><span class="identifier">density_impl</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<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> Args<span class="special">></span> <a name="idp66728448-bb"></a><span class="identifier">density_impl</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="id876816"></a><h3> -<a name="id562594-bb"></a><code class="computeroutput">density_impl</code> public member functions</h3> +<a name="idp109323088"></a><h3> +<a name="idp66721808-bb"></a><code class="computeroutput">density_impl</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> Args<span class="special">></span> <span class="keyword">void</span> <a name="id562597-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="keyword">void</span> <a name="idp66722368-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="identifier">result_type</span> <a name="id562617-bb"></a><span class="identifier">result</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<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> Args<span class="special">></span> <span class="identifier">result_type</span> <a name="idp66724752-bb"></a><span class="identifier">result</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <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">Requires:</span></p></td> <td><p>The number of samples must meet or exceed the cache size </p></td> @@ -89,7 +86,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../extract/density.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.density_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="../tag/density.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="covariance_impl.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_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="error_of_mean_impl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |