doc/test/gold/boost/accumulators/impl/weighted_tail_quantile__id226526.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Struct template weighted_tail_quantile_impl</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125">
<link rel="home" href="../../../index.html" title="Document To Test Formatting">
<link rel="up" href="../../../document_to_test_formatting/accumulators.html#header.boost.trunk.doc.test.weighted_tail_quantile_hpp" title="Header &lt;boost/trunk/doc/test/weighted_tail_quantile.hpp&gt;">
<link rel="prev" href="../extract/weighted_tail_quantile.html" title="Global weighted_tail_quantile">
<link rel="next" href="../tag/weighted_tail_quantile.html" title="Struct template weighted_tail_quantile">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../extract/weighted_tail_quantile.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.boost.trunk.doc.test.weighted_tail_quantile_hpp"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../tag/weighted_tail_quantile.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.accumulators.impl.weighted_tail_quantile__id226526"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template weighted_tail_quantile_impl</span></h2>
<p>boost::accumulators::impl::weighted_tail_quantile_impl &#8212; Tail quantile estimation based on order statistics of weighted samples (for both left and right tails). </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="emphasis"><em>// In header: &lt;<a class="link" href="../../../document_to_test_formatting/accumulators.html#header.boost.trunk.doc.test.weighted_tail_quantile_hpp" title="Header &lt;boost/trunk/doc/test/weighted_tail_quantile.hpp&gt;">boost/trunk/doc/test/weighted_tail_quantile.hpp</a>&gt;

</em></span><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Sample, <span class="bold"><strong>typename</strong></span> Weight, <span class="bold"><strong>typename</strong></span> LeftRight&gt; 
<span class="bold"><strong>struct</strong></span> <a class="link" href="weighted_tail_quantile__id226526.html" title="Struct template weighted_tail_quantile_impl">weighted_tail_quantile_impl</a> {
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> numeric::functional::average&lt; Weight, std::size_t &gt;::result_type <a name="boost.accumulators.impl.weighted_tail_quantile__id226526.float_type"></a>float_type; 
  <span class="bold"><strong>typedef</strong></span> Sample                                                           <a name="boost.accumulators.impl.weighted_tail_quantile__id226526.result_type"></a>result_type;

  <span class="emphasis"><em>// <a class="link" href="weighted_tail_quantile__id226526.html#boost.accumulators.impl.weighted_tail_quantile__id226526construct-copy-destruct">construct/copy/destruct</a></em></span>
  <a class="link" href="weighted_tail_quantile__id226526.html#id226362-bb">weighted_tail_quantile_impl</a>(dont_care);

  <span class="emphasis"><em>// <a class="link" href="weighted_tail_quantile__id226526.html#id226739-bb">public member functions</a></em></span>
  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Args&gt; <span class="type">result_type</span> <a class="link" href="weighted_tail_quantile__id226526.html#id226647-bb">result</a>(Args <span class="bold"><strong>const</strong></span> &amp;) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id545120"></a><h2>Description</h2>
<p>An estimator <span class="inlinemediaobject"><img src="../../../images/accumulators/form_0.png"></span> of tail quantiles with level <span class="inlinemediaobject"><img src="../../../images/accumulators/form_1.png"></span> based on order statistics <span class="inlinemediaobject"><img src="../../../images/accumulators/form_2.png"></span> of weighted samples are given by <span class="inlinemediaobject"><img src="../../../images/accumulators/form_3.png"></span> (left tail) and <span class="inlinemediaobject"><img src="../../../images/accumulators/form_4.png"></span> (right tail), where</p>
<div class="equation">
<a name="id545243"></a><p class="title"><b>Equation�1.�</b></p>
<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_5.png" align="middle"></div></div>
</div>
<p><br class="equation-break"></p>
<p>and</p>
<div class="equation">
<a name="id545273"></a><p class="title"><b>Equation�2.�</b></p>
<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_6.png" align="middle"></div></div>
</div>
<p><br class="equation-break"></p>
<p><span class="inlinemediaobject"><img src="../../../images/accumulators/form_7.png"></span> being the number of samples and <span class="inlinemediaobject"><img src="../../../images/accumulators/form_8.png"></span> the sum of all weights.</p>
<p>
</p>
<div class="refsect2" lang="en">
<a name="id545349"></a><h3>
<a name="boost.accumulators.impl.weighted_tail_quantile__id226526construct-copy-destruct"></a><code class="computeroutput">weighted_tail_quantile_impl</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id226362-bb"></a>weighted_tail_quantile_impl(dont_care);</pre></li></ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id545388"></a><h3>
<a name="id226739-bb"></a><code class="computeroutput">weighted_tail_quantile_impl</code> public member functions</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Args&gt; <span class="type">result_type</span> <a name="id226647-bb"></a>result(Args <span class="bold"><strong>const</strong></span> &amp; args) <span class="bold"><strong>const</strong></span>;</pre></li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright � 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias
      Capeletto<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../extract/weighted_tail_quantile.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.boost.trunk.doc.test.weighted_tail_quantile_hpp"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../tag/weighted_tail_quantile.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>