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
|
<!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: GeneralizedBlackScholesProcess 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.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_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a></div>
<h1>GeneralizedBlackScholesProcess Class Reference<br>
<small>
[<a class="el" href="group__processes.html">Stochastic processes</a>]</small>
</h1><!-- doxytag: class="QuantLib::GeneralizedBlackScholesProcess" --><!-- doxytag: inherits="QuantLib::StochasticProcess1D" --><code>#include <ql/processes/blackscholesprocess.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for GeneralizedBlackScholesProcess:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_generalized_black_scholes_process__inherit__graph.png" border="0" usemap="#_generalized_black_scholes_process__inherit__map" alt="Inheritance graph"></center>
<map name="_generalized_black_scholes_process__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_black_process.html" title="Black (1976) stochastic process." alt="" coords="5,161,109,188"><area shape="rect" href="class_quant_lib_1_1_black_scholes_merton_process.html" title="Merton (1973) extension to the Black-Scholes stochastic process." alt="" coords="133,161,333,188"><area shape="rect" href="class_quant_lib_1_1_black_scholes_process.html" title="Black-Scholes (1973) stochastic process." alt="" coords="357,161,512,188"><area shape="rect" href="class_quant_lib_1_1_garman_kohlagen_process.html" title="Garman-Kohlhagen (1983) stochastic process." alt="" coords="536,161,720,188"><area shape="rect" href="class_quant_lib_1_1_stochastic_process1_d.html" title="1-dimensional stochastic process" alt="" coords="255,7,412,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_generalized_black_scholes_process-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Generalized Black-Scholes stochastic process.
<p>
This class describes the stochastic process governed by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dS(t, S) = (r(t) - q(t) - \frac{\sigma(t, S)^2}{2}) dt + \sigma dW_t. \]" src="form_254.png">
<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="3df0b86a1ef1cf90ccd7403887d2453a"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::GeneralizedBlackScholesProcess" ref="3df0b86a1ef1cf90ccd7403887d2453a" args="(const Handle< Quote > &x0, const Handle< YieldTermStructure > &dividendTS, const Handle< YieldTermStructure > &riskFreeTS, const Handle< BlackVolTermStructure > &blackVolTS, const boost::shared_ptr< discretization > &d=boost::shared_ptr< discretization >(new EulerDiscretization))" -->
</td><td class="memItemRight" valign="bottom"><b>GeneralizedBlackScholesProcess</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > &x0, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &dividendTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &riskFreeTS, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> > &blackVolTS, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_stochastic_process_1_1discretization.html">discretization</a> > &d=boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_stochastic_process_1_1discretization.html">discretization</a> >(new <a class="el" href="class_quant_lib_1_1_euler_discretization.html">EulerDiscretization</a>))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#f8a1d4ca4369b3009d08291f1c2d7744">time</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">StochasticProcess1D interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89d2f497b5fd0d0a0dce2ec82c86e778"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::x0" ref="89d2f497b5fd0d0a0dce2ec82c86e778" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#89d2f497b5fd0d0a0dce2ec82c86e778">x0</a> () const </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="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#545d33724b1d6d312eb8a17f73571842">drift</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#b4d7fe4af7a6dd0ae710c073569821e4">diffusion</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#ee1aadb67f9085eb8a9fc89604bd8ead">apply</a> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x0, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> dx) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Observer interface</div></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_generalized_black_scholes_process.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fdbbd388a2432e1d8d9e94136acfdb8"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::stateVariable" ref="3fdbbd388a2432e1d8d9e94136acfdb8" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > & </td><td class="memItemRight" valign="bottom"><b>stateVariable</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d410a408dd37b79578b370b5219dbf80"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::dividendYield" ref="d410a408dd37b79578b370b5219dbf80" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a><br>
< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > & </td><td class="memItemRight" valign="bottom"><b>dividendYield</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="925fdf9de4dd73519b36f975bc7917a8"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::riskFreeRate" ref="925fdf9de4dd73519b36f975bc7917a8" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a><br>
< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > & </td><td class="memItemRight" valign="bottom"><b>riskFreeRate</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="966c6dd76f94ceda5c3a344a8f3e3a8b"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::blackVolatility" ref="966c6dd76f94ceda5c3a344a8f3e3a8b" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a><br>
< <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> > & </td><td class="memItemRight" valign="bottom"><b>blackVolatility</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f113ff5ac835cfc641b3ccf701c030b5"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::localVolatility" ref="f113ff5ac835cfc641b3ccf701c030b5" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a><br>
< <a class="el" href="class_quant_lib_1_1_local_vol_term_structure.html">LocalVolTermStructure</a> > & </td><td class="memItemRight" valign="bottom"><b>localVolatility</b> () const </td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="545d33724b1d6d312eb8a17f73571842"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::drift" ref="545d33724b1d6d312eb8a17f73571842" args="(Time t, Real x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> drift </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"> <em>x</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>
<dl compact><dt><b><a class="el" href="todo.html#_todo000045">Possible enhancements:</a></b></dt><dd>revise extrapolation </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#6bded8896a46fad4d189950552432cd3">StochasticProcess1D</a>.</p>
</div>
</div><p>
<a class="anchor" name="b4d7fe4af7a6dd0ae710c073569821e4"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::diffusion" ref="b4d7fe4af7a6dd0ae710c073569821e4" args="(Time t, Real x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> diffusion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"> <em>x</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>
<dl compact><dt><b><a class="el" href="todo.html#_todo000046">Possible enhancements:</a></b></dt><dd>revise extrapolation </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#faf479da3baa52185b369071b1689d89">StochasticProcess1D</a>.</p>
</div>
</div><p>
<a class="anchor" name="ee1aadb67f9085eb8a9fc89604bd8ead"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::apply" ref="ee1aadb67f9085eb8a9fc89604bd8ead" args="(Real x0, Real dx) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"> <em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </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_285.png">.
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#905bb2d5a924e5274035b0850c3e04fb">StochasticProcess1D</a>.</p>
</div>
</div><p>
<a class="anchor" name="f8a1d4ca4369b3009d08291f1c2d7744"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::time" ref="f8a1d4ca4369b3009d08291f1c2d7744" args="(const Date &) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> time </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the time value corresponding to the given date in the reference system of the stochastic process.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>As a number of processes might not need this functionality, a default implementation is given which raises an exception. </dd></dl>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_stochastic_process.html#cb2c915740d2c20c6ee1f5c27b05caef">StochasticProcess</a>.</p>
</div>
</div><p>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::GeneralizedBlackScholesProcess::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void update </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes.
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_stochastic_process.html#c5c54df7ed3b930268c8d7752c101725">StochasticProcess</a>.</p>
</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>
|