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 145 146 147
|
<!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: RandomizedLDS 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_randomized_l_d_s.html">RandomizedLDS</a></div>
<h1>RandomizedLDS Class Template Reference</h1><!-- doxytag: class="QuantLib::RandomizedLDS" --><code>#include <ql/math/randomnumbers/randomizedlds.hpp></code>
<p>
<p>
<a href="class_quant_lib_1_1_randomized_l_d_s-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class LDS, class PRS = RandomSequenceGenerator<MersenneTwisterUniformRng>><br>
class QuantLib::RandomizedLDS< LDS, PRS ></h3>
Randomized (random shift) low-discrepancy sequence.
<p>
Random-shifts a uniform low-discrepancy sequence of dimension <img class="formulaInl" alt="$ N $" src="form_36.png"> by adding (modulo 1 for each coordinate) a pseudo-random uniform deviate in <img class="formulaInl" alt="$ (0, 1)^N. $" src="form_170.png"> It is used for implementing Randomized Quasi Monte Carlo.<p>
The uniform low discrepancy sequence is supplied by LDS; the uniform pseudo-random sequence is supplied by PRS.<p>
Both class LDS and PRS must implement the following interface: <div class="fragment"><pre class="fragment"> LDS::sample_type LDS::nextSequence() <span class="keyword">const</span>;
<a class="code" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77" title="size of a container">Size</a> LDS::dimension() <span class="keyword">const</span>;
</pre></div><p>
<dl class="pre" compact><dt><b>Precondition:</b></dt><dd>LDS and PRS must have the same dimension <img class="formulaInl" alt="$ N $" src="form_36.png"></dd></dl>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000057">Warning:</a></b></dt><dd>Inverting LDS and PRS is possible, but it doesn't make sense.</dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000022">Possible enhancements:</a></b></dt><dd>implement the other randomization algorithms</dd></dl>
<dl compact><dt><b><a class="el" href="test.html#_test000046">Tests:</a></b></dt><dd>correct initialization is tested. </dd></dl>
<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="f3b59a3dd56521693efc68c221a2bf38"></a><!-- doxytag: member="QuantLib::RandomizedLDS::sample_type" ref="f3b59a3dd56521693efc68c221a2bf38" args="" -->
typedef <a class="el" href="struct_quant_lib_1_1_sample.html">Sample</a>< std::vector<br>
< <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> > > </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="b9c8b1032e33e44aab7d913df6b30a2a"></a><!-- doxytag: member="QuantLib::RandomizedLDS::RandomizedLDS" ref="b9c8b1032e33e44aab7d913df6b30a2a" args="(const LDS &ldsg, const PRS &prsg)" -->
</td><td class="memItemRight" valign="bottom"><b>RandomizedLDS</b> (const LDS &ldsg, const PRS &prsg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd982aebe39f5fb3b1d5b556c3909859"></a><!-- doxytag: member="QuantLib::RandomizedLDS::RandomizedLDS" ref="fd982aebe39f5fb3b1d5b556c3909859" args="(const LDS &ldsg)" -->
</td><td class="memItemRight" valign="bottom"><b>RandomizedLDS</b> (const LDS &ldsg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5cd3bf450cb608c0a9c7c516a5d5009"></a><!-- doxytag: member="QuantLib::RandomizedLDS::RandomizedLDS" ref="d5cd3bf450cb608c0a9c7c516a5d5009" args="(Size dimensionality, BigNatural ldsSeed=0, BigNatural prsSeed=0)" -->
</td><td class="memItemRight" valign="bottom"><b>RandomizedLDS</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> dimensionality, <a class="el" href="namespace_quant_lib.html#e3df3f13e67885465f4e359b3bffa4e6">BigNatural</a> ldsSeed=0, <a class="el" href="namespace_quant_lib.html#e3df3f13e67885465f4e359b3bffa4e6">BigNatural</a> prsSeed=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ea25ac8138d4099afda3642057335ff"></a><!-- doxytag: member="QuantLib::RandomizedLDS::nextSequence" ref="2ea25ac8138d4099afda3642057335ff" args="() const " -->
const <a class="el" href="struct_quant_lib_1_1_sample.html">sample_type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_randomized_l_d_s.html#2ea25ac8138d4099afda3642057335ff">nextSequence</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns next sample using a given randomizing vector <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d216498c4107b3bca19b47a929407fc"></a><!-- doxytag: member="QuantLib::RandomizedLDS::lastSequence" ref="8d216498c4107b3bca19b47a929407fc" args="() const " -->
const <a class="el" href="struct_quant_lib_1_1_sample.html">sample_type</a> & </td><td class="memItemRight" valign="bottom"><b>lastSequence</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_randomized_l_d_s.html#a917583553cf612af05e8b75e7e161dc">nextRandomizer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d089a89a18aa50ad2c64712cf5fb5e3d"></a><!-- doxytag: member="QuantLib::RandomizedLDS::dimension" ref="d089a89a18aa50ad2c64712cf5fb5e3d" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a917583553cf612af05e8b75e7e161dc"></a><!-- doxytag: member="QuantLib::RandomizedLDS::nextRandomizer" ref="a917583553cf612af05e8b75e7e161dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void nextRandomizer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update the randomizing vector and re-initialize the low discrepancy generator
</div>
</div><p>
</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>
|