doc/html/boost/accumulators/impl/tail_variate_means_impl.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template tail_variate_means_impl</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.tail_variate_means_hpp" title="Header &lt;boost/accumulators/statistics/tail_variate_means.hpp&gt;">
   9 <link rel="prev" href="../extract/relative_tail_var_id571486.html" title="Global relative_tail_variate_means">
  10 <link rel="next" href="../tag/absolute_tail_var_id571829.html" title="Struct template absolute_tail_variate_means">
  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="../../../../../libs/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="../extract/relative_tail_var_id571486.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.tail_variate_means_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/absolute_tail_var_id571829.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.accumulators.impl.tail_variate_means_impl"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template tail_variate_means_impl</span></h2>
  29 <p>boost::accumulators::impl::tail_variate_means_impl &#8212; Estimation of the absolute and relative tail variate means (for both left and right tails) </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="../../../accumulators/reference.html#header.boost.accumulators.statistics.tail_variate_means_hpp" title="Header &lt;boost/accumulators/statistics/tail_variate_means.hpp&gt;">boost/accumulators/statistics/tail_variate_means.hpp</a>&gt;
  33
  34 </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> Impl<span class="special">,</span> <span class="keyword">typename</span> LeftRight<span class="special">,</span>
  35          <span class="keyword">typename</span> VariateTag<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="tail_variate_means_impl.html" title="Struct template tail_variate_means_impl">tail_variate_means_impl</a> <span class="special">{</span>
  37   <span class="comment">// types</span>
  38   <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">&lt;</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">&gt;</span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.accumulators.impl.tail_variate_means_impl.float_type"></a><span class="identifier">float_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">float_type</span> <span class="special">&gt;</span>                                        <a name="boost.accumulators.impl.tail_variate_means_impl.array_type"></a><span class="identifier">array_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">iterator_range</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">array_type</span><span class="special">::</span><span class="identifier">iterator</span> <span class="special">&gt;</span>                  <a name="boost.accumulators.impl.tail_variate_means_impl.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="tail_variate_means_impl.html#boost.accumulators.impl.tail_variate_means_implconstruct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="tail_variate_means_impl.html#id571819-bb"><span class="identifier">tail_variate_means_impl</span></a><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="tail_variate_means_impl.html#id571795-bb">public member functions</a></span>
  46   <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="tail_variate_means_impl.html#id571798-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>
  47 <span class="special">}</span><span class="special">;</span></pre></div>
  48 <div class="refsect1">
  49 <a name="id945780"></a><h2>Description</h2>
  50 <p>For all <span class="inlinemediaobject"><img src="../../../images/accumulators/form_65.png"></span>-th variates associated to the <span class="inlinemediaobject"><img src="../../../images/accumulators/form_59.png"></span> largest samples (or the <span class="inlinemediaobject"><img src="../../../images/accumulators/form_59.png"></span> smallest samples in case of the left tail), the absolute tail means <span class="inlinemediaobject"><img src="../../../images/accumulators/form_66.png"></span> are computed and returned as an iterator range. Alternatively, the relative tail means <span class="inlinemediaobject"><img src="../../../images/accumulators/form_67.png"></span> are returned, which are the absolute tail means normalized with the (non-coherent) sample tail mean <span class="inlinemediaobject"><img src="../../../images/accumulators/form_55.png"></span>.</p>
  51 <div class="equation">
  52 <a name="id945913"></a><p class="title"><b>Equation&#160;1.17.&#160;</b></p>
  53 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_68.png" align="middle"></div></div>
  54 </div>
  55 <p><br class="equation-break"></p>
  56 <div class="equation">
  57 <a name="id945940"></a><p class="title"><b>Equation&#160;1.18.&#160;</b></p>
  58 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_69.png" align="middle"></div></div>
  59 </div>
  60 <p><br class="equation-break"></p>
  61 <div class="equation">
  62 <a name="id945967"></a><p class="title"><b>Equation&#160;1.19.&#160;</b></p>
  63 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_70.png" align="middle"></div></div>
  64 </div>
  65 <p><br class="equation-break"></p>
  66 <div class="equation">
  67 <a name="id945996"></a><p class="title"><b>Equation&#160;1.20.&#160;</b></p>
  68 <div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_71.png" align="middle"></div></div>
  69 </div>
  70 <p><br class="equation-break"> </p>
  71 <div class="refsect2">
  72 <a name="id946024"></a><h3>
  73 <a name="boost.accumulators.impl.tail_variate_means_implconstruct-copy-destruct"></a><code class="computeroutput">tail_variate_means_impl</code>
  74         public
  75        construct/copy/destruct</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id571819-bb"></a><span class="identifier">tail_variate_means_impl</span><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  77 </div>
  78 <div class="refsect2">
  79 <a name="id946079"></a><h3>
  80 <a name="id571795-bb"></a><code class="computeroutput">tail_variate_means_impl</code> public member functions</h3>
  81 <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="id571798-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>
  82 </div>
  83 </div>
  84 </div>
  85 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  86 <td align="left"></td>
  87 <td align="right"><div class="copyright-footer">Copyright &#169; 2005, 2006 Eric Niebler<p>
  88         Distributed under the Boost Software License, Version 1.0. (See accompanying
  89         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>)
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="../extract/relative_tail_var_id571486.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.tail_variate_means_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/absolute_tail_var_id571829.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>