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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
|
<!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: StochasticProcess1D 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_stochastic_process1_d.html">StochasticProcess1D</a></div>
<h1>StochasticProcess1D Class Reference</h1><!-- doxytag: class="QuantLib::StochasticProcess1D" --><!-- doxytag: inherits="QuantLib::StochasticProcess" --><code>#include <ql/stochasticprocess.hpp></code>
<p>
Inheritance diagram for StochasticProcess1D:<p><center><img src="class_quant_lib_1_1_stochastic_process1_d__inherit__graph.png" border="0" usemap="#_stochastic_process1_d__inherit__map" alt="Inheritance graph"></center>
<map name="_stochastic_process1_d__inherit__map">
<area href="class_quant_lib_1_1_forward_measure_process1_d.html" shape="rect" coords="434,6,636,30" alt="">
<area href="class_quant_lib_1_1_generalized_black_scholes_process.html" shape="rect" coords="414,54,656,78" alt="">
<area href="class_quant_lib_1_1_geometric_brownian_motion_process.html" shape="rect" coords="410,102,660,126" alt="">
<area href="class_quant_lib_1_1_hull_white_process.html" shape="rect" coords="466,150,604,174" alt="">
<area href="class_quant_lib_1_1_merton76_process.html" shape="rect" coords="467,198,603,222" alt="">
<area href="class_quant_lib_1_1_ornstein_uhlenbeck_process.html" shape="rect" coords="435,246,635,270" alt="">
<area href="class_quant_lib_1_1_square_root_process.html" shape="rect" coords="460,294,610,318" alt="">
<area href="class_quant_lib_1_1_stochastic_process.html" shape="rect" coords="7,150,148,174" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_stochastic_process1_d-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
1-dimensional stochastic process
<p>
This class describes a stochastic process governed by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dx_t = \mu(t, x_t)dt + \sigma(t, x_t)dW_t. \]" src="form_241.png">
<p>
<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 colspan="2"><div class="groupHeader">1-D stochastic process interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="25203cac75731710eb4902823065b095"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::x0" ref="25203cac75731710eb4902823065b095" args="() const=0" -->
virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#25203cac75731710eb4902823065b095">x0</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the initial value of the state variable <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e06f30a6c4425e8c3e4633d1cf15c761"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::drift" ref="e06f30a6c4425e8c3e4633d1cf15c761" args="(Time t, Real x) const=0" -->
virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#e06f30a6c4425e8c3e4633d1cf15c761">drift</a> (Time t, Real x) const=0</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, x_t) $" src="form_251.png"> <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9df3a04e3fab76cdee05ab834d5b7cb3"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::diffusion" ref="9df3a04e3fab76cdee05ab834d5b7cb3" args="(Time t, Real x) const=0" -->
virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#9df3a04e3fab76cdee05ab834d5b7cb3">diffusion</a> (Time t, Real x) const=0</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, x_t) $" src="form_252.png"> <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#ee564ee8adf46c50265cd990b1dcd8a3">expectation</a> (Time t0, Real x0, Time dt) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#bb8a7016bec7d28872df221fb8995853">stdDeviation</a> (Time t0, Real x0, Time dt) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#5e92435fcc5c43be09e627494cf7a9d0">variance</a> (Time t0, Real x0, Time dt) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#096b196eb0c6e453acbd428ae378c7de">evolve</a> (Time t0, Real x0, Time dt, Real dw) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#6c8e95cb5b48a9ca86fef990c92c58c9">apply</a> (Real x0, Real dx) 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="704996c48f48a23c4db6a6549a094807"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::StochasticProcess1D" ref="704996c48f48a23c4db6a6549a094807" args="(const boost::shared_ptr< discretization > &)" -->
</td><td class="memItemRight" valign="bottom"><b>StochasticProcess1D</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_stochastic_process1_d_1_1discretization.html">discretization</a> > &)</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="ea3658beebc66268a48cf5273cce6abd"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::discretization_" ref="ea3658beebc66268a48cf5273cce6abd" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_stochastic_process1_d_1_1discretization.html">discretization</a> > </td><td class="memItemRight" valign="bottom"><b>discretization_</b></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_stochastic_process1_d_1_1discretization.html">discretization</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">discretization of a 1-D stochastic process <a href="class_quant_lib_1_1_stochastic_process1_d_1_1discretization.html#_details">More...</a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ee564ee8adf46c50265cd990b1dcd8a3"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::expectation" ref="ee564ee8adf46c50265cd990b1dcd8a3" args="(Time t0, Real x0, Time dt) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Real 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">Real </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(x_{t_0 + \Delta t} | x_{t_0} = x_0) $" src="form_253.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 in <a class="el" href="class_quant_lib_1_1_hull_white_process.html#f718d7a907863b462830ca96dda4321c">HullWhiteProcess</a>, <a class="el" href="class_quant_lib_1_1_hull_white_forward_process.html#f718d7a907863b462830ca96dda4321c">HullWhiteForwardProcess</a>, and <a class="el" href="class_quant_lib_1_1_ornstein_uhlenbeck_process.html#f718d7a907863b462830ca96dda4321c">OrnsteinUhlenbeckProcess</a>.
</div>
</div><p>
<a class="anchor" name="bb8a7016bec7d28872df221fb8995853"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::stdDeviation" ref="bb8a7016bec7d28872df221fb8995853" args="(Time t0, Real x0, Time dt) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Real 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">Real </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(x_{t_0 + \Delta t} | x_{t_0} = x_0) $" src="form_254.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 in <a class="el" href="class_quant_lib_1_1_hull_white_process.html#c731332c432f5be07edc3bda917e6ea0">HullWhiteProcess</a>, <a class="el" href="class_quant_lib_1_1_hull_white_forward_process.html#c731332c432f5be07edc3bda917e6ea0">HullWhiteForwardProcess</a>, and <a class="el" href="class_quant_lib_1_1_ornstein_uhlenbeck_process.html#c731332c432f5be07edc3bda917e6ea0">OrnsteinUhlenbeckProcess</a>.
</div>
</div><p>
<a class="anchor" name="5e92435fcc5c43be09e627494cf7a9d0"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::variance" ref="5e92435fcc5c43be09e627494cf7a9d0" args="(Time t0, Real x0, Time dt) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Real variance </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">Real </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 variance <img class="formulaInl" alt="$ V(x_{t_0 + \Delta t} | x_{t_0} = x_0) $" src="form_255.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 in <a class="el" href="class_quant_lib_1_1_hull_white_process.html#5da3e29d59b0c10b20f760739de77535">HullWhiteProcess</a>, <a class="el" href="class_quant_lib_1_1_hull_white_forward_process.html#5da3e29d59b0c10b20f760739de77535">HullWhiteForwardProcess</a>, and <a class="el" href="class_quant_lib_1_1_ornstein_uhlenbeck_process.html#5da3e29d59b0c10b20f760739de77535">OrnsteinUhlenbeckProcess</a>.
</div>
</div><p>
<a class="anchor" name="096b196eb0c6e453acbd428ae378c7de"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::evolve" ref="096b196eb0c6e453acbd428ae378c7de" args="(Time t0, Real x0, Time dt, Real dw) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Real evolve </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">Real </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Real </td>
<td class="paramname"> <em>dw</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 asset value after a time interval <img class="formulaInl" alt="$ \Delta t $" src="form_245.png"> according to the given discretization. By default, it returns <p class="formulaDsp">
<img class="formulaDsp" alt="\[ E(x_0,t_0,\Delta t) + S(x_0,t_0,\Delta t) \cdot \Delta w \]" src="form_256.png">
<p>
where <img class="formulaInl" alt="$ E $" src="form_249.png"> is the expectation and <img class="formulaInl" alt="$ S $" src="form_135.png"> the standard deviation.
</div>
</div><p>
<a class="anchor" name="6c8e95cb5b48a9ca86fef990c92c58c9"></a><!-- doxytag: member="QuantLib::StochasticProcess1D::apply" ref="6c8e95cb5b48a9ca86fef990c92c58c9" args="(Real x0, Real dx) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Real apply </td>
<td>(</td>
<td class="paramtype">Real </td>
<td class="paramname"> <em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Real </td>
<td class="paramname"> <em>dx</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>
applies a change to the asset value. By default, it returns <img class="formulaInl" alt="$ x + \Delta x $" src="form_257.png">.
<p>
Reimplemented in <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#181565755d35d36c7bf732e1905f3661">GeneralizedBlackScholesProcess</a>, and <a class="el" href="class_quant_lib_1_1_merton76_process.html#80c11f9def74e04938f4c2319722c37c">Merton76Process</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>
|