File: class_quant_lib_1_1_inverse_cumulative_rng.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (113 lines) | stat: -rw-r--r-- 6,032 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
<!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: InverseCumulativeRng 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.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_inverse_cumulative_rng.html">InverseCumulativeRng</a></div>
<h1>InverseCumulativeRng Class Template Reference</h1><!-- doxytag: class="QuantLib::InverseCumulativeRng" --><code>#include &lt;ql/math/randomnumbers/inversecumulativerng.hpp&gt;</code>
<p>

<p>
<a href="class_quant_lib_1_1_inverse_cumulative_rng-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class RNG, class IC&gt;<br>
 class QuantLib::InverseCumulativeRng&lt; RNG, IC &gt;</h3>

Inverse cumulative random number generator. 
<p>
It uses a 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 is supplied by RNG.<p>
Class RNG must implement the following interface: <div class="fragment"><pre class="fragment">            RNG::sample_type RNG::next() <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" title="real number">Real</a> IC::operator() <span class="keyword">const</span>;
</pre></div> <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="d6ae312199547dfd98f3b79b89a036f0"></a><!-- doxytag: member="QuantLib::InverseCumulativeRng::sample_type" ref="d6ae312199547dfd98f3b79b89a036f0" args="" -->
typedef <a class="el" href="struct_quant_lib_1_1_sample.html">Sample</a>&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>sample_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf33bf876d7887a0d4a55f3d3ebba7ba"></a><!-- doxytag: member="QuantLib::InverseCumulativeRng::urng_type" ref="bf33bf876d7887a0d4a55f3d3ebba7ba" args="" -->
typedef RNG&nbsp;</td><td class="memItemRight" valign="bottom"><b>urng_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="94c3ceb8818a466b6bd20dcb49d2665f"></a><!-- doxytag: member="QuantLib::InverseCumulativeRng::InverseCumulativeRng" ref="94c3ceb8818a466b6bd20dcb49d2665f" args="(const RNG &amp;uniformGenerator)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>InverseCumulativeRng</b> (const RNG &amp;uniformGenerator)</td></tr>

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

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a sample from a Gaussian distribution <br></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>