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
|
<!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: 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.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_rsg.html">InverseCumulativeRsg</a></div>
<h1>InverseCumulativeRsg Class Template Reference</h1><!-- doxytag: class="QuantLib::InverseCumulativeRsg" --><code>#include <ql/math/randomnumbers/inversecumulativersg.hpp></code>
<p>
<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<class USG, class IC><br>
class QuantLib::InverseCumulativeRsg< USG, IC ></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" title="size of a container">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" title="real number">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#_a25">DiscreteHedging.cpp</a>.</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::InverseCumulativeRsg::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="23eac1260e2d993498bd6dfe74993b1b"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::InverseCumulativeRsg" ref="23eac1260e2d993498bd6dfe74993b1b" args="(const USG &uniformSequenceGenerator)" -->
</td><td class="memItemRight" valign="bottom"><b>InverseCumulativeRsg</b> (const USG &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 &uniformSequenceGenerator, const IC &inverseCumulative)" -->
</td><td class="memItemRight" valign="bottom"><b>InverseCumulativeRsg</b> (const USG &uniformSequenceGenerator, const IC &inverseCumulative)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adadd6dc6ad0a8242f2b9a20e18b7391"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::nextSequence" ref="adadd6dc6ad0a8242f2b9a20e18b7391" 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_inverse_cumulative_rsg.html#adadd6dc6ad0a8242f2b9a20e18b7391">nextSequence</a> () const </td></tr>
<tr><td class="mdescLeft"> </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="8d216498c4107b3bca19b47a929407fc"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::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"><a class="anchor" name="d089a89a18aa50ad2c64712cf5fb5e3d"></a><!-- doxytag: member="QuantLib::InverseCumulativeRsg::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>
</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>
|