File: class_quant_lib_1_1_random_sequence_generator.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,952 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>RandomSequenceGenerator&lt; RNG &gt; 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="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_random_sequence_generator.html">RandomSequenceGenerator</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">RandomSequenceGenerator&lt; RNG &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::RandomSequenceGenerator" -->
<p>Random sequence generator based on a pseudo-random number generator.  
 <a href="class_quant_lib_1_1_random_sequence_generator.html#details">More...</a></p>

<p><code>#include &lt;ql/math/randomnumbers/randomsequencegenerator.hpp&gt;</code></p>

<p><a href="class_quant_lib_1_1_random_sequence_generator-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="af3b59a3dd56521693efc68c221a2bf38"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::sample_type" ref="af3b59a3dd56521693efc68c221a2bf38" args="" -->
typedef <a class="el" href="struct_quant_lib_1_1_sample.html">Sample</a>&lt; std::vector<br class="typebreak"/>
&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>sample_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="a58caaa6b289fac085580152fc34831cf"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::RandomSequenceGenerator" ref="a58caaa6b289fac085580152fc34831cf" args="(Size dimensionality, const RNG &amp;rng)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>RandomSequenceGenerator</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> dimensionality, const RNG &amp;rng)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa011e1cb13276720be0bd1999c3c48c"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::RandomSequenceGenerator" ref="afa011e1cb13276720be0bd1999c3c48c" args="(Size dimensionality, BigNatural seed=0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>RandomSequenceGenerator</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> dimensionality, BigNatural seed=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15b541124ea01ca45ea29f675c261246"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::nextSequence" ref="a15b541124ea01ca45ea29f675c261246" args="() const " -->
const <a class="el" href="struct_quant_lib_1_1_sample.html">sample_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>nextSequence</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9063e25330911ad101c3d075e6db0dc"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::nextInt32Sequence" ref="af9063e25330911ad101c3d075e6db0dc" args="() const " -->
std::vector&lt; BigNatural &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>nextInt32Sequence</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d216498c4107b3bca19b47a929407fc"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::lastSequence" ref="a8d216498c4107b3bca19b47a929407fc" args="() const " -->
const <a class="el" href="struct_quant_lib_1_1_sample.html">sample_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>lastSequence</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad089a89a18aa50ad2c64712cf5fb5e3d"></a><!-- doxytag: member="QuantLib::RandomSequenceGenerator::dimension" ref="ad089a89a18aa50ad2c64712cf5fb5e3d" args="() const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class RNG&gt;<br/>
class QuantLib::RandomSequenceGenerator&lt; RNG &gt;</h3>

<p>Random sequence generator based on a pseudo-random number generator. </p>
<p>Random sequence generator based on a pseudo-random number generator RNG.</p>
<p>Class RNG must implement the following interface: </p>
<div class="fragment"><pre class="fragment">            RNG::sample_type RNG::next() <span class="keyword">const</span>;
</pre></div><p> If a client of this class wants to use the nextInt32Sequence method, class RNG must also implement </p>
<div class="fragment"><pre class="fragment">            <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> RNG::nextInt32() <span class="keyword">const</span>;
</pre></div><dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000072">Warning:</a></b></dt><dd>do not use with low-discrepancy sequence generator. </dd></dl>
</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>