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
|
<!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>BatesProcess 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="185" height="50" 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 1.2</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="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="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="examples.html">Examples</a></li>
</ul>
</div>
<div id="content">
<!--Doxygen-generated content-->
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>QuantLib</b> </li>
<li class="navelem"><a class="el" href="class_quant_lib_1_1_bates_process.html">BatesProcess</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">BatesProcess Class Reference<div class="ingroups"><a class="el" href="group__processes.html">Stochastic processes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::BatesProcess" --><!-- doxytag: inherits="QuantLib::HestonProcess" -->
<p>Square-root stochastic-volatility Bates process.
<a href="class_quant_lib_1_1_bates_process.html#details">More...</a></p>
<p><code>#include <ql/processes/batesprocess.hpp></code></p>
<div class="dynheader">
Inheritance diagram for BatesProcess:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_bates_process__inherit__graph.png" border="0" usemap="#_bates_process_inherit__map" alt="Inheritance graph"/></div>
<map name="_bates_process_inherit__map" id="_bates_process_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_heston_process.html" title="Square-root stochastic-volatility Heston process." alt="" coords="5,6,115,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_bates_process-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa53ab896db19eca97e8e53bb62b3d29e"></a><!-- doxytag: member="QuantLib::BatesProcess::BatesProcess" ref="aa53ab896db19eca97e8e53bb62b3d29e" args="(const Handle< YieldTermStructure > &riskFreeRate, const Handle< YieldTermStructure > &dividendYield, const Handle< Quote > &s0, Real v0, Real kappa, Real theta, Real sigma, Real rho, Real lambda, Real nu, Real delta, HestonProcess::Discretization d=HestonProcess::FullTruncation)" -->
 </td><td class="memItemRight" valign="bottom"><b>BatesProcess</b> (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> > &riskFreeRate, 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> > &dividendYield, 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> > &s0, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> v0, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> kappa, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> theta, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> sigma, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> rho, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> lambda, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> nu, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> delta, HestonProcess::Discretization d=HestonProcess::FullTruncation)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af712ecab6d5754978fed3860efc7f661"></a><!-- doxytag: member="QuantLib::BatesProcess::factors" ref="af712ecab6d5754978fed3860efc7f661" args="() const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_bates_process.html#af712ecab6d5754978fed3860efc7f661">factors</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the number of independent factors of the process <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af971c27bf35db18d8e7e7374e7cf234c"></a><!-- doxytag: member="QuantLib::BatesProcess::drift" ref="af971c27bf35db18d8e7e7374e7cf234c" 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_bates_process.html#af971c27bf35db18d8e7e7374e7cf234c">drift</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> 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_351.png"/> <br/></td></tr>
<tr><td class="memItemLeft" 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_bates_process.html#a89ac97af7698aa193a9c0731dcdd9d8a">evolve</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &x0, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> dt, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &dw) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24cb1182953e872918829ca60b348e54"></a><!-- doxytag: member="QuantLib::BatesProcess::lambda" ref="a24cb1182953e872918829ca60b348e54" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>lambda</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69c12ede1099bb0263342867dd12e045"></a><!-- doxytag: member="QuantLib::BatesProcess::nu" ref="a69c12ede1099bb0263342867dd12e045" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>nu</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2397bf69d6801e3328c9273143c87ce6"></a><!-- doxytag: member="QuantLib::BatesProcess::delta" ref="a2397bf69d6801e3328c9273143c87ce6" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>delta</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Square-root stochastic-volatility Bates process. </p>
<p>This class describes the square root stochastic volatility process incl jumps governed by </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ \begin{array}{rcl} dS(t, S) &=& (r-d-\lambda m) S dt +\sqrt{v} S dW_1 + (e^J - 1) S dN \\ dv(t, S) &=& \kappa (\theta - v) dt + \sigma \sqrt{v} dW_2 \\ dW_1 dW_2 &=& \rho dt \\ \omega(J) &=& \frac{1}{\sqrt{2\pi \delta^2}} \exp\left[-\frac{(J-\nu)^2}{2\delta^2}\right] \end{array} \]" src="form_327.png"/>
</p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_equity_option_8cpp-example.html#_a30">EquityOption.cpp</a>.</dd>
</dl></div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a89ac97af7698aa193a9c0731dcdd9d8a"></a><!-- doxytag: member="QuantLib::BatesProcess::evolve" ref="a89ac97af7698aa193a9c0731dcdd9d8a" args="(Time t0, const Array &x0, Time dt, const Array &dw) 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>> <a class="el" href="class_quant_lib_1_1_bates_process.html#a89ac97af7698aa193a9c0731dcdd9d8a">evolve</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </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"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"><em>dt</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>dw</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> 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_354.png"/> according to the given discretization. By default, it returns </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ E(\mathrm{x}_0,t_0,\Delta t) + S(\mathrm{x}_0,t_0,\Delta t) \cdot \Delta \mathrm{w} \]" src="form_357.png"/>
</p>
<p> where <img class="formulaInl" alt="$ E $" src="form_358.png"/> is the expectation and <img class="formulaInl" alt="$ S $" src="form_212.png"/> the standard deviation. </p>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_heston_process.html#a89ac97af7698aa193a9c0731dcdd9d8a">HestonProcess</a>.</p>
</div>
</div>
</div><!-- contents -->
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>
</div>
</body>
</html>
|