libs/histogram/doc/html/boost/histogram/accumulators/weighted_mean.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template weighted_mean</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Histogram">
   8 <link rel="up" href="../../../histogram/reference.html#header.boost.histogram.accumulators.weighted_mean_hpp" title="Header &lt;boost/histogram/accumulators/weighted_mean.hpp&gt;">
   9 <link rel="prev" href="thread_safe.html" title="Class template thread_safe">
  10 <link rel="next" href="weighted_sum.html" title="Class template weighted_sum">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="thread_safe.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.accumulators.weighted_mean_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="weighted_sum.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.accumulators.weighted_mean"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template weighted_mean</span></h2>
  29 <p>boost::histogram::accumulators::weighted_mean &#8212; Calculates mean and variance of weighted sample. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="../../../histogram/reference.html#header.boost.histogram.accumulators.weighted_mean_hpp" title="Header &lt;boost/histogram/accumulators/weighted_mean.hpp&gt;">boost/histogram/accumulators/weighted_mean.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="weighted_mean.html#boost.histogram.accumulators.weighted_meanconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="weighted_mean.html#idm45414525076144-bb"><span class="identifier">weighted_mean</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  39   <a class="link" href="weighted_mean.html#idm45414525075584-bb"><span class="identifier">weighted_mean</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">,</span>
  40                 <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="weighted_mean.html#idm45414525099328-bb">public member functions</a></span>
  43   <span class="keyword">void</span> <a class="link" href="weighted_mean.html#idm45414525098768-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">void</span> <a class="link" href="weighted_mean.html#idm45414525097232-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../weight_type.html" title="Struct template weight_type">weight_type</a><span class="special">&lt;</span> <span class="identifier">RealType</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a> <span class="special">&amp;</span> <a class="link" href="weighted_mean.html#idm45414525094560-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a> <span class="special">&amp;</span> <a class="link" href="weighted_mean.html#idm45414525091440-bb"><span class="keyword">operator</span> <span class="special">*=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  48     <span class="keyword">bool</span> <a class="link" href="weighted_mean.html#idm45414525089616-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  49   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="weighted_mean.html#idm45414525086512-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  50   <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> <a class="link" href="weighted_mean.html#idm45414525083856-bb"><span class="identifier">sum_of_weights</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  51   <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> <a class="link" href="weighted_mean.html#idm45414525082736-bb"><span class="identifier">sum_of_weights_squared</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  52   <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> <a class="link" href="weighted_mean.html#idm45414525081616-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  53   <span class="identifier">RealType</span> <a class="link" href="weighted_mean.html#idm45414525080496-bb"><span class="identifier">variance</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="weighted_mean.html#idm45414525079376-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span>
  55 <span class="special">}</span><span class="special">;</span></pre></div>
  56 <div class="refsect1">
  57 <a name="idm45212148542304"></a><h2>Description</h2>
  58 <p>Uses West's incremental algorithm to improve numerical stability of mean and variance computation. </p>
  59 <div class="refsect2">
  60 <a name="idm45212148541520"></a><h3>
  61 <a name="boost.histogram.accumulators.weighted_meanconstruct-copy-destruct"></a><code class="computeroutput">weighted_mean</code>
  62         public
  63        construct/copy/destruct</h3>
  64 <div class="orderedlist"><ol class="orderedlist" type="1">
  65 <li class="listitem"><pre class="literallayout"><a name="idm45414525076144-bb"></a><span class="identifier">weighted_mean</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  66 <li class="listitem"><pre class="literallayout"><a name="idm45414525075584-bb"></a><span class="identifier">weighted_mean</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> wsum<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> wsum2<span class="special">,</span>
  67               <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> mean<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> variance<span class="special">)</span><span class="special">;</span></pre></li>
  68 </ol></div>
  69 </div>
  70 <div class="refsect2">
  71 <a name="idm45212148520384"></a><h3>
  72 <a name="idm45414525099328-bb"></a><code class="computeroutput">weighted_mean</code> public member functions</h3>
  73 <div class="orderedlist"><ol class="orderedlist" type="1">
  74 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45414525098768-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
  75 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45414525097232-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../weight_type.html" title="Struct template weight_type">weight_type</a><span class="special">&lt;</span> <span class="identifier">RealType</span> <span class="special">&gt;</span> <span class="special">&amp;</span> w<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
  76 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  77   <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a> <span class="special">&amp;</span> <a name="idm45414525094560-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre></li>
  78 <li class="listitem"><pre class="literallayout"><a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a> <span class="special">&amp;</span> <a name="idm45414525091440-bb"></a><span class="keyword">operator</span> <span class="special">*=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> s<span class="special">)</span><span class="special">;</span></pre></li>
  79 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  80   <span class="keyword">bool</span> <a name="idm45414525089616-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="weighted_mean.html" title="Class template weighted_mean">weighted_mean</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  81 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45414525086512-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  82 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> <a name="idm45414525083856-bb"></a><span class="identifier">sum_of_weights</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  83 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> <a name="idm45414525082736-bb"></a><span class="identifier">sum_of_weights_squared</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</span> <a name="idm45414525081616-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  85 <li class="listitem"><pre class="literallayout"><span class="identifier">RealType</span> <a name="idm45414525080496-bb"></a><span class="identifier">variance</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  86 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45414525079376-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span></pre></li>
  87 </ol></div>
  88 </div>
  89 </div>
  90 </div>
  91 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  92 <td align="left"></td>
  93 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  94       Dembinski<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="thread_safe.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.accumulators.weighted_mean_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="weighted_sum.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>