File: class_quant_lib_1_1_discrepancy_statistics.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (131 lines) | stat: -rw-r--r-- 7,631 bytes parent folder | download 
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta name="robots" content="none">
<title>DiscrepancyStatistics Class Reference</title>
<link rel="stylesheet" href="quantlib.css" type="text/css">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link rel="icon" href="favicon.ico" type="image/x-icon">
</head>
<body>

<div id="container">
<div id="header">
<img class="titleimage"
 src="QL-title.jpg" width="185" height="50" border="0"
 alt="QuantLib">
<br>
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
</div>
<div id="menu">

<h3 class="navbartitle">Version 1.2</h3>

<hr>

<h3 class="navbartitle">Getting started</h3>
<ul class="navbarlist">
<li class="navlink"><a href="index.html">Introduction</a></li>
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
<li class="navlink"><a href="install.html">Installation</a></li>
<li class="navlink"><a href="config.html">Configuration</a></li>
<li class="navlink"><a href="usage.html">Usage</a></li>
<li class="navlink"><a href="history.html">Version history</a></li>
<li class="navlink"><a href="resources.html">Additional resources</a></li>
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
<li class="navlink"><a href="license.html">Copyright and license</a></li>
</ul>

<hr>

<h3 class="navbartitle">Reference manual</h3>
<ul class="navbarlist">
<li class="navlink"><a href="modules.html">Modules</a></li>
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
<li class="navlink"><a href="annotated.html">Compound List</a></li>
<li class="navlink"><a href="files.html">File List</a></li>
<li class="navlink"><a href="functions.html">Compound Members</a></li>
<li class="navlink"><a href="globals.html">File Members</a></li>
<li class="navlink"><a href="todo.html">Todo List</a></li>
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
<li class="navlink"><a href="caveats.html">Caveats</a></li>
<li class="navlink"><a href="test.html">Test Suite</a></li>
<li class="navlink"><a href="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_discrepancy_statistics.html">DiscrepancyStatistics</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">DiscrepancyStatistics Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::DiscrepancyStatistics" --><!-- doxytag: inherits="QuantLib::GenericSequenceStatistics" -->
<p>Statistic tool for sequences with discrepancy calculation.  
 <a href="class_quant_lib_1_1_discrepancy_statistics.html#details">More...</a></p>

<p><code>#include &lt;ql/math/statistics/discrepancystatistics.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for DiscrepancyStatistics:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_discrepancy_statistics__inherit__graph.png" border="0" usemap="#_discrepancy_statistics_inherit__map" alt="Inheritance graph"/></div>
<map name="_discrepancy_statistics_inherit__map" id="_discrepancy_statistics_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_generic_sequence_statistics.html" title="Statistics analysis of N&#45;dimensional (sequence) data." alt="" coords="13,6,147,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_discrepancy_statistics-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a098d1b826c2efcfccac368aa5c2d6cc0"></a><!-- doxytag: member="QuantLib::DiscrepancyStatistics::value_type" ref="a098d1b826c2efcfccac368aa5c2d6cc0" args="" -->
typedef <br class="typebreak"/>
SequenceStatistics::value_type&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9796065f48d4502cb41326f68720a67"></a><!-- doxytag: member="QuantLib::DiscrepancyStatistics::DiscrepancyStatistics" ref="ab9796065f48d4502cb41326f68720a67" args="(Size dimension)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>DiscrepancyStatistics</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> dimension)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a1f278171ca690f5a6c24ca31583fdad6"></a><!-- doxytag: member="QuantLib::DiscrepancyStatistics::add" ref="a1f278171ca690f5a6c24ca31583fdad6" args="(const Sequence &amp;sample, Real weight=1.0)" -->
template&lt;class Sequence &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>add</b> (const Sequence &amp;sample, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> weight=1.0)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="aec007c1f57d0a048f8cc541dc3614137"></a><!-- doxytag: member="QuantLib::DiscrepancyStatistics::add" ref="aec007c1f57d0a048f8cc541dc3614137" args="(Iterator begin, Iterator end, Real weight=1.0)" -->
template&lt;class Iterator &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>add</b> (Iterator begin, Iterator end, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> weight=1.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58bd77d1d091d636b8d5400814152bc5"></a><!-- doxytag: member="QuantLib::DiscrepancyStatistics::reset" ref="a58bd77d1d091d636b8d5400814152bc5" args="(Size dimension=0)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> dimension=0)</td></tr>
<tr><td colspan="2"><div class="groupHeader">1-dimensional inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a122ecc93c99621dc327be1f4dec2849a"></a><!-- doxytag: member="QuantLib::DiscrepancyStatistics::discrepancy" ref="a122ecc93c99621dc327be1f4dec2849a" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>discrepancy</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Statistic tool for sequences with discrepancy calculation. </p>
<p>It inherit from SequenceStatistics&lt;Statistics&gt; and adds <img class="formulaInl" alt="$ L^2 $" src="form_247.png"/> discrepancy calculation </p>
</div></div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>