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
132
|
<!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>QuantLib: Histogram 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="212" height="47" 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 0.9.0</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="overview.html">Project overview</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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_histogram.html">Histogram</a></div>
<h1>Histogram Class Reference</h1><!-- doxytag: class="QuantLib::Histogram" --><code>#include <ql/math/statistics/histogram.hpp></code>
<p>
<p>
<a href="class_quant_lib_1_1_histogram-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="class_quant_lib_1_1_histogram.html" title="Histogram class.">Histogram</a> class.
<p>
This class computes the histogram of a given data set. The caller can specify the number of bins, the breaks, or the algorithm for determining these quantities in computing the histogram. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>Algorithm</b> { <b>None</b>,
<b>Sturges</b>,
<b>FD</b>,
<b>Scott</b>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f51c4df08524a7d196bd62f31e4bc50f"></a><!-- doxytag: member="QuantLib::Histogram::Histogram" ref="f51c4df08524a7d196bd62f31e4bc50f" args="()" -->
</td><td class="memItemRight" valign="bottom"><b>Histogram</b> ()</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="02adf4214673199104a47192f08f39fd"></a><!-- doxytag: member="QuantLib::Histogram::Histogram" ref="02adf4214673199104a47192f08f39fd" args="(T data_begin, T data_end, Size breaks)" -->
template<class T> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>Histogram</b> (T data_begin, T data_end, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> breaks)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="99a4307a357d418b34834a2640f10f5d"></a><!-- doxytag: member="QuantLib::Histogram::Histogram" ref="99a4307a357d418b34834a2640f10f5d" args="(T data_begin, T data_end, Algorithm algorithm)" -->
template<class T> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>Histogram</b> (T data_begin, T data_end, Algorithm algorithm)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="1da8d2911dce8251854b07d080f92ace"></a><!-- doxytag: member="QuantLib::Histogram::Histogram" ref="1da8d2911dce8251854b07d080f92ace" args="(T data_begin, T data_end, U breaks_begin, U breaks_end)" -->
template<class T, class U> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>Histogram</b> (T data_begin, T data_end, U breaks_begin, U breaks_end)</td></tr>
<tr><td colspan="2"><div class="groupHeader">inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18099aedcd39e72c751cc7cd30dba0d7"></a><!-- doxytag: member="QuantLib::Histogram::bins" ref="18099aedcd39e72c751cc7cd30dba0d7" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>bins</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76063bc3f4d54bbabe5ffac5b43845a3"></a><!-- doxytag: member="QuantLib::Histogram::breaks" ref="76063bc3f4d54bbabe5ffac5b43845a3" args="() const " -->
const std::vector< <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> > & </td><td class="memItemRight" valign="bottom"><b>breaks</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e4af7419144ae5528fa318b30752a42"></a><!-- doxytag: member="QuantLib::Histogram::algorithm" ref="7e4af7419144ae5528fa318b30752a42" args="() const " -->
Algorithm </td><td class="memItemRight" valign="bottom"><b>algorithm</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6e61de369e994009e36f344f99c15ad"></a><!-- doxytag: member="QuantLib::Histogram::empty" ref="c6e61de369e994009e36f344f99c15ad" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>empty</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">results</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c985675085bbe718933ca1db2b3b005d"></a><!-- doxytag: member="QuantLib::Histogram::counts" ref="c985675085bbe718933ca1db2b3b005d" args="(Size i) const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>counts</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7bb6aa81b5de0ababfb432c3cb346b5c"></a><!-- doxytag: member="QuantLib::Histogram::frequency" ref="7bb6aa81b5de0ababfb432c3cb346b5c" args="(Size i) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>frequency</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>
</table>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|
