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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
<!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: G2ForwardProcess Class 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_g2_forward_process.html">G2ForwardProcess</a></div>
<h1>G2ForwardProcess Class Reference<br>
<small>
[<a class="el" href="group__processes.html">Stochastic processes</a>]</small>
</h1><!-- doxytag: class="QuantLib::G2ForwardProcess" --><!-- doxytag: inherits="QuantLib::ForwardMeasureProcess" --><code>#include <ql/Processes/g2process.hpp></code>
<p>
Inheritance diagram for G2ForwardProcess:<p><center><img src="class_quant_lib_1_1_g2_forward_process__inherit__graph.png" border="0" usemap="#_g2_forward_process__inherit__map" alt="Inheritance graph"></center>
<map name="_g2_forward_process__inherit__map">
<area href="class_quant_lib_1_1_forward_measure_process.html" shape="rect" coords="12,156,196,180" alt="">
<area href="class_quant_lib_1_1_stochastic_process.html" shape="rect" coords="33,81,175,105" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="5,7,88,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="112,7,211,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_g2_forward_process-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
forward G2 stochastic process
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="ff3b1a8d266d0fe23fb9720e4b1c4617"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::G2ForwardProcess" ref="ff3b1a8d266d0fe23fb9720e4b1c4617" args="(Real a, Real sigma, Real b, Real eta, Real rho)" -->
</td><td class="memItemRight" valign="bottom"><b>G2ForwardProcess</b> (Real a, Real sigma, Real b, Real eta, Real rho)</td></tr>
<tr><td colspan="2"><div class="groupHeader">StochasticProcess interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cce0ab2cacc475b2434f24c65c91685a"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::size" ref="cce0ab2cacc475b2434f24c65c91685a" args="() const" -->
Size </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#cce0ab2cacc475b2434f24c65c91685a">size</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the number of dimensions of the stochastic process <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="370c708931771eb9459d0ac2db0426ee"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::initialValues" ref="370c708931771eb9459d0ac2db0426ee" args="() const" -->
<a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#370c708931771eb9459d0ac2db0426ee">initialValues</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the initial values of the state variables <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e716cd0b67d0a8183a4ffa4ff394757"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::drift" ref="9e716cd0b67d0a8183a4ffa4ff394757" args="(Time t, const Array &x) const" -->
<a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#9e716cd0b67d0a8183a4ffa4ff394757">drift</a> (Time t, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the drift part of the equation, i.e., <img class="formulaInl" alt="$ \mu(t, \mathrm{x}_t) $" src="form_242.png"> <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00c42da0242ba9ac04b2842dc9f0acd9"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::diffusion" ref="00c42da0242ba9ac04b2842dc9f0acd9" args="(Time t, const Array &x) const" -->
<a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#00c42da0242ba9ac04b2842dc9f0acd9">diffusion</a> (Time t, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the diffusion part of the equation, i.e. <img class="formulaInl" alt="$ \sigma(t, \mathrm{x}_t) $" src="form_243.png"> <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#51943d498d07fcfacfd0290f810c5b36">expectation</a> (Time t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x0, Time dt) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#20608f1018c118acbc8b4a6419cef517">stdDeviation</a> (Time t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x0, Time dt) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>< <a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_forward_process.html#86fdc03d99e5766f1e0908205b80148a">covariance</a> (Time t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x0, Time dt) const</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c679b55c1897e30b52a79f5c8858a777"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::xForwardDrift" ref="c679b55c1897e30b52a79f5c8858a777" args="(Time t, Time T) const" -->
Real </td><td class="memItemRight" valign="bottom"><b>xForwardDrift</b> (Time t, Time T) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f94eec6b98619a8d2df005027e445a0"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::yForwardDrift" ref="8f94eec6b98619a8d2df005027e445a0" args="(Time t, Time T) const" -->
Real </td><td class="memItemRight" valign="bottom"><b>yForwardDrift</b> (Time t, Time T) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="926124164e3075717cfaca803452dfe4"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::Mx_T" ref="926124164e3075717cfaca803452dfe4" args="(Real s, Real t, Real T) const" -->
Real </td><td class="memItemRight" valign="bottom"><b>Mx_T</b> (Real s, Real t, Real T) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a8d10b790f82d05de7e08c0e23abd48"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::My_T" ref="7a8d10b790f82d05de7e08c0e23abd48" args="(Real s, Real t, Real T) const" -->
Real </td><td class="memItemRight" valign="bottom"><b>My_T</b> (Real s, Real t, Real T) const</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb597b35edab96eecbcbf9a2df04f05d"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::x0_" ref="fb597b35edab96eecbcbf9a2df04f05d" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>x0_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11822cc7a38fbfe7925643c3f280283c"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::y0_" ref="11822cc7a38fbfe7925643c3f280283c" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>y0_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="114bd3f70557109ba551776610bb2dc1"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::a_" ref="114bd3f70557109ba551776610bb2dc1" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>a_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37293181f9beea97f75b133deb9d9119"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::sigma_" ref="37293181f9beea97f75b133deb9d9119" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>sigma_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d5754808d36bc0b9f0326d84a42efb8"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::b_" ref="0d5754808d36bc0b9f0326d84a42efb8" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>b_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06e2d64229bb485ee1dbf0abef8a0d4d"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::eta_" ref="06e2d64229bb485ee1dbf0abef8a0d4d" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>eta_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98f57706bc57f4e14ca8c8cb1cfa213b"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::rho_" ref="98f57706bc57f4e14ca8c8cb1cfa213b" args="" -->
Real </td><td class="memItemRight" valign="bottom"><b>rho_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0138ade8861b6b96ad34f5113aa5a278"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::xProcess_" ref="0138ade8861b6b96ad34f5113aa5a278" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_ornstein_uhlenbeck_process.html">QuantLib::OrnsteinUhlenbeckProcess</a> > </td><td class="memItemRight" valign="bottom"><b>xProcess_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fd6ac924df1ebbc25944f4a7a261aaa"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::yProcess_" ref="6fd6ac924df1ebbc25944f4a7a261aaa" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_ornstein_uhlenbeck_process.html">QuantLib::OrnsteinUhlenbeckProcess</a> > </td><td class="memItemRight" valign="bottom"><b>yProcess_</b></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="51943d498d07fcfacfd0290f810c5b36"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::expectation" ref="51943d498d07fcfacfd0290f810c5b36" args="(Time t0, const Array &x0, Time dt) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a><<a class="el" href="class_quant_lib_1_1_array.html">Array</a>> expectation </td>
<td>(</td>
<td class="paramtype">Time </td>
<td class="paramname"> <em>t0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> & </td>
<td class="paramname"> <em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Time </td>
<td class="paramname"> <em>dt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the expectation <img class="formulaInl" alt="$ E(\mathrm{x}_{t_0 + \Delta t} | \mathrm{x}_{t_0} = \mathrm{x}_0) $" src="form_244.png"> of the process after a time interval <img class="formulaInl" alt="$ \Delta t $" src="form_245.png"> according to the given discretization. This method can be overridden in derived classes which want to hard-code a particular discretization.
<p>
Reimplemented from <a class="el" href="class_quant_lib_1_1_stochastic_process.html#5ff82c7ea229ea678252bca22f1ee455">StochasticProcess</a>.
</div>
</div><p>
<a class="anchor" name="20608f1018c118acbc8b4a6419cef517"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::stdDeviation" ref="20608f1018c118acbc8b4a6419cef517" args="(Time t0, const Array &x0, Time dt) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a><<a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a>> stdDeviation </td>
<td>(</td>
<td class="paramtype">Time </td>
<td class="paramname"> <em>t0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> & </td>
<td class="paramname"> <em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Time </td>
<td class="paramname"> <em>dt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the standard deviation <img class="formulaInl" alt="$ S(\mathrm{x}_{t_0 + \Delta t} | \mathrm{x}_{t_0} = \mathrm{x}_0) $" src="form_246.png"> of the process after a time interval <img class="formulaInl" alt="$ \Delta t $" src="form_245.png"> according to the given discretization. This method can be overridden in derived classes which want to hard-code a particular discretization.
<p>
Reimplemented from <a class="el" href="class_quant_lib_1_1_stochastic_process.html#1d143e05259160f677407c6cb3b7d8b4">StochasticProcess</a>.
</div>
</div><p>
<a class="anchor" name="86fdc03d99e5766f1e0908205b80148a"></a><!-- doxytag: member="QuantLib::G2ForwardProcess::covariance" ref="86fdc03d99e5766f1e0908205b80148a" args="(Time t0, const Array &x0, Time dt) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a><<a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a>> covariance </td>
<td>(</td>
<td class="paramtype">Time </td>
<td class="paramname"> <em>t0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> & </td>
<td class="paramname"> <em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Time </td>
<td class="paramname"> <em>dt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the covariance <img class="formulaInl" alt="$ V(\mathrm{x}_{t_0 + \Delta t} | \mathrm{x}_{t_0} = \mathrm{x}_0) $" src="form_247.png"> of the process after a time interval <img class="formulaInl" alt="$ \Delta t $" src="form_245.png"> according to the given discretization. This method can be overridden in derived classes which want to hard-code a particular discretization.
<p>
Reimplemented from <a class="el" href="class_quant_lib_1_1_stochastic_process.html#7d7d88e8f05305804aed59a6521f8a36">StochasticProcess</a>.
</div>
</div><p>
</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>
|