doc/html/boost/accumulators/impl/non_coherent__idp417492272.html

   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=US-ASCII">
   5 <title>Struct template non_coherent_weighted_tail_mean_impl</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.statistics_fwd_hpp" title="Header &lt;boost/accumulators/statistics_fwd.hpp&gt;">
  10 <link rel="prev" href="weighted_sum_kahan_impl.html" title="Struct template weighted_sum_kahan_impl">
  11 <link rel="next" href="weighted_tail_idp417525184.html" title="Struct template weighted_tail_quantile_impl">
  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="weighted_sum_kahan_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="weighted_tail_idp417525184.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.accumulators.impl.non_coherent__idp417492272"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template non_coherent_weighted_tail_mean_impl</span></h2>
  30 <p>boost::accumulators::impl::non_coherent_weighted_tail_mean_impl &#8212; Estimation of the (non-coherent) weighted tail mean based on order statistics (for both left and right tails) </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.statistics_fwd_hpp" title="Header &lt;boost/accumulators/statistics_fwd.hpp&gt;">boost/accumulators/statistics_fwd.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Sample<span class="special">,</span> <span class="keyword">typename</span> Weight<span class="special">,</span> <span class="keyword">typename</span> LeftRight<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="non_coherent__idp417492272.html" title="Struct template non_coherent_weighted_tail_mean_impl">non_coherent_weighted_tail_mean_impl</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">accumulator_base</span> <span class="special">{</span>
  37   <span class="comment">// <a class="link" href="non_coherent__idp417492272.html#boost.accumulators.impl.non_coherent__idp417492272construct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="non_coherent__idp417492272.html#idp417524304-bb"><span class="identifier">non_coherent_weighted_tail_mean_impl</span></a><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="non_coherent__idp417492272.html#idp417521312-bb">public member functions</a></span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="non_coherent__idp417492272.html#idp417521808-bb"><span class="identifier">result</span></a><span class="special">(</span><span class="identifier">Args</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="special">}</span><span class="special">;</span></pre></div>
  43 <div class="refsect1">
  44 <a name="idp118309520"></a><h2>Description</h2>
  45 <p>An estimation of the non-coherent, weighted tail mean <span class="inlinemediaobject"><img src="../../../images/accumulators//form_70.png"></span> is given by the weighted mean of the</p>
  46 <div class="equation">
  47 <a name="idp118312848"></a><p class="title"><b>Equation&#160;1.38.&#160;</b></p>
  48 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_97.png" align="middle"></div></div>
  49 </div>
  50 <p><br class="equation-break"></p>
  51 <p>smallest samples (left tail) or the weighted mean of the</p>
  52 <div class="equation">
  53 <a name="idp118316128"></a><p class="title"><b>Equation&#160;1.39.&#160;</b></p>
  54 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_98.png" align="middle"></div></div>
  55 </div>
  56 <p><br class="equation-break"></p>
  57 <p>largest samples (right tail) above a quantile <span class="inlinemediaobject"><img src="../../../images/accumulators//form_99.png"></span> of level <span class="inlinemediaobject"><img src="../../../images/accumulators//form_45.png"></span>, <span class="inlinemediaobject"><img src="../../../images/accumulators//form_75.png"></span> being the total number of sample and <span class="inlinemediaobject"><img src="../../../images/accumulators//form_95.png"></span> the sum of all <span class="inlinemediaobject"><img src="../../../images/accumulators//form_75.png"></span> weights:</p>
  58 <div class="equation">
  59 <a name="idp118331392"></a><p class="title"><b>Equation&#160;1.40.&#160;</b></p>
  60 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_100.png" align="middle"></div></div>
  61 </div>
  62 <p><br class="equation-break"></p>
  63 <div class="equation">
  64 <a name="idp118334368"></a><p class="title"><b>Equation&#160;1.41.&#160;</b></p>
  65 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_101.png" align="middle"></div></div>
  66 </div>
  67 <p><br class="equation-break"></p>
  68 <p>
  69 </p>
  70 <div class="refsect2">
  71 <a name="idp118337472"></a><h3>
  72 <a name="boost.accumulators.impl.non_coherent__idp417492272construct-copy-destruct"></a><code class="computeroutput">non_coherent_weighted_tail_mean_impl</code>
  73         public
  74        construct/copy/destruct</h3>
  75 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp417524304-bb"></a><span class="identifier">non_coherent_weighted_tail_mean_impl</span><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  76 </div>
  77 <div class="refsect2">
  78 <a name="idp118344064"></a><h3>
  79 <a name="idp417521312-bb"></a><code class="computeroutput">non_coherent_weighted_tail_mean_impl</code> public member functions</h3>
  80 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idp417521808-bb"></a><span class="identifier">result</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div>
  81 </div>
  82 </div>
  83 </div>
  84 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  85 <td align="left"></td>
  86 <td align="right"><div class="copyright-footer">Copyright &#169; 2005, 2006 Eric Niebler<p>
  87         Distributed under the Boost Software License, Version 1.0. (See accompanying
  88         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>)
  89       </p>
  90 </div></td>
  91 </tr></table>
  92 <hr>
  93 <div class="spirit-nav">
  94 <a accesskey="p" href="weighted_sum_kahan_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="weighted_tail_idp417525184.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  95 </div>
  96 </body>
  97 </html>