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=UTF-8"> 5<title>Struct template tail_variate_means_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 <boost/accumulators/statistics_fwd.hpp>"> 10<link rel="prev" href="tail_variate_impl.html" title="Struct template tail_variate_impl"> 11<link rel="next" href="variance_impl.html" title="Struct template variance_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="tail_variate_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="variance_impl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.accumulators.impl.tail_variate_means_impl"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Struct template tail_variate_means_impl</span></h2> 30<p>boost::accumulators::impl::tail_variate_means_impl — Estimation of the absolute and relative tail variate means (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: <<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>> 34 35</span><span class="keyword">template</span><span class="special"><</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> 36 <span class="keyword">typename</span> VariateTag<span class="special">></span> 37<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> <span class="keyword">public</span> <span class="identifier">accumulator_base</span> <span class="special">{</span> 38 <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> 39 <a class="link" href="tail_variate_means_impl.html#id-1_3_2_6_3_59_1_1_22_35_6-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> 40 41 <span class="comment">// <a class="link" href="tail_variate_means_impl.html#id-1_3_2_6_3_59_1_1_22_35_5-bb">public member functions</a></span> 42 <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="tail_variate_means_impl.html#id-1_3_2_6_3_59_1_1_22_35_5_1-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> 43 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">></span> <span class="keyword">void</span> <a class="link" href="tail_variate_means_impl.html#id-1_3_2_6_3_59_1_1_22_35_5_2-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> 44<span class="special">}</span><span class="special">;</span></pre></div> 45<div class="refsect1"> 46<a name="id-1.3.2.6.3.57.39.4"></a><h2>Description</h2> 47<p>For all <span class="inlinemediaobject"><img src="../../../images/accumulators//form_9.png"></span>-th variates associated to the <span class="inlinemediaobject"><img src="../../../images/accumulators//form_60.png"></span> largest samples (or the <span class="inlinemediaobject"><img src="../../../images/accumulators//form_60.png"></span> smallest samples in case of the left tail), the absolute tail means <span class="inlinemediaobject"><img src="../../../images/accumulators//form_12.png"></span> are computed and returned as an iterator range. Alternatively, the relative tail means <span class="inlinemediaobject"><img src="../../../images/accumulators//form_13.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_14.png"></span>.</p> 48<div class="equation"> 49<a name="id-1.3.2.6.3.57.39.4.3.1"></a><p class="title"><b>Equation 1.32. </b></p> 50<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_61.png" align="middle"></div></div> 51</div> 52<p><br class="equation-break"></p> 53<div class="equation"> 54<a name="id-1.3.2.6.3.57.39.4.4.1"></a><p class="title"><b>Equation 1.33. </b></p> 55<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_62.png" align="middle"></div></div> 56</div> 57<p><br class="equation-break"></p> 58<div class="equation"> 59<a name="id-1.3.2.6.3.57.39.4.5.1"></a><p class="title"><b>Equation 1.34. </b></p> 60<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_63.png" align="middle"></div></div> 61</div> 62<p><br class="equation-break"></p> 63<div class="equation"> 64<a name="id-1.3.2.6.3.57.39.4.6.1"></a><p class="title"><b>Equation 1.35. </b></p> 65<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators//form_64.png" align="middle"></div></div> 66</div> 67<p><br class="equation-break"> </p> 68<div class="refsect2"> 69<a name="id-1.3.2.6.3.57.39.4.7"></a><h3> 70<a name="boost.accumulators.impl.tail_variate_means_implconstruct-copy-destruct"></a><code class="computeroutput">tail_variate_means_impl</code> 71 public 72 construct/copy/destruct</h3> 73<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id-1_3_2_6_3_59_1_1_22_35_6-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> 74</div> 75<div class="refsect2"> 76<a name="id-1.3.2.6.3.57.39.4.8"></a><h3> 77<a name="id-1_3_2_6_3_59_1_1_22_35_5-bb"></a><code class="computeroutput">tail_variate_means_impl</code> public member functions</h3> 78<div class="orderedlist"><ol class="orderedlist" type="1"> 79<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="id-1_3_2_6_3_59_1_1_22_35_5_1-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></li> 80<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">></span> 81 <span class="keyword">void</span> <a name="id-1_3_2_6_3_59_1_1_22_35_5_2-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></li> 82</ol></div> 83</div> 84</div> 85</div> 86<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 87<td align="left"></td> 88<td align="right"><div class="copyright-footer">Copyright © 2005, 2006 Eric Niebler<p> 89 Distributed under the Boost Software License, Version 1.0. (See accompanying 90 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>) 91 </p> 92</div></td> 93</tr></table> 94<hr> 95<div class="spirit-nav"> 96<a accesskey="p" href="tail_variate_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="variance_impl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 97</div> 98</body> 99</html> 100
