File: class_quant_lib_1_1_inverse_cumulative_rsg.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (144 lines) | stat: -rw-r--r-- 7,967 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
132
133
134
135
136
137
138
139
140
141
142
143
144
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: InverseCumulativeRsg Class Template 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_inverse_cumulative_rsg.html">InverseCumulativeRsg</a></div>
<h1>InverseCumulativeRsg Class Template Reference</h1><!-- doxytag: class="QuantLib::InverseCumulativeRsg" --><code>#include &lt;ql/RandomNumbers/inversecumulativersg.hpp&gt;</code>
<p>
<a href="class_quant_lib_1_1_inverse_cumulative_rsg-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class USG, class IC&gt;<br>
 class QuantLib::InverseCumulativeRsg&lt; USG, IC &gt;</h3>

Inverse cumulative random sequence generator. 
<p>
It uses a sequence of uniform deviate in (0, 1) as the source of cumulative distribution values. Then an inverse cumulative distribution is used to calculate the distribution deviate.<p>
The uniform deviate sequence is supplied by USG.<p>
Class USG must implement the following interface: <div class="fragment"><pre class="fragment">            USG::sample_type USG::nextSequence() <span class="keyword">const</span>;
            <a class="code" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> USG::dimension() <span class="keyword">const</span>;
</pre></div><p>
The inverse cumulative distribution is supplied by IC.<p>
Class IC must implement the following interface: <div class="fragment"><pre class="fragment">            IC::IC();
            <a class="code" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> IC::operator() <span class="keyword">const</span>;
</pre></div> <dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_discrete_hedging_8cpp-example.html#_a24">DiscreteHedging.cpp</a>.</dl>
<p>
<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"><a class="anchor" name="c10175ab8a401908363648e5f3dad08d"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::sample_type" ref="c10175ab8a401908363648e5f3dad08d" args="" -->
typedef <a class="el" href="struct_quant_lib_1_1_sample.html">Sample</a>&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>sample_type</b></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23eac1260e2d993498bd6dfe74993b1b"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::InverseCumulativeRsg" ref="23eac1260e2d993498bd6dfe74993b1b" args="(const USG &amp;uniformSequenceGenerator)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>InverseCumulativeRsg</b> (const USG &amp;uniformSequenceGenerator)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f017e7f142be2fc69eb956293fd74a2c"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::InverseCumulativeRsg" ref="f017e7f142be2fc69eb956293fd74a2c" args="(const USG &amp;uniformSequenceGenerator, const IC &amp;inverseCumulative)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>InverseCumulativeRsg</b> (const USG &amp;uniformSequenceGenerator, const IC &amp;inverseCumulative)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c92cc517f79f09c8ce3fa89da43c51ba"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::nextSequence" ref="c92cc517f79f09c8ce3fa89da43c51ba" args="() const" -->
const <a class="el" href="struct_quant_lib_1_1_sample.html">sample_type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inverse_cumulative_rsg.html#c92cc517f79f09c8ce3fa89da43c51ba">nextSequence</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns next sample from the Gaussian distribution <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21fb9bff0e8370796df2b4a9d16b372b"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::lastSequence" ref="21fb9bff0e8370796df2b4a9d16b372b" args="() const" -->
const <a class="el" href="struct_quant_lib_1_1_sample.html">sample_type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>lastSequence</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d909a81181d49375588c96fd1494043"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::dimension" ref="6d909a81181d49375588c96fd1494043" args="() const" -->
Size&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const</td></tr>

</table>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>