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
|
<!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: HestonModel 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_heston_model.html">HestonModel</a></div>
<h1>HestonModel Class Reference</h1><!-- doxytag: class="QuantLib::HestonModel" --><!-- doxytag: inherits="QuantLib::CalibratedModel" --><code>#include <ql/ShortRateModels/TwoFactorModels/hestonmodel.hpp></code>
<p>
Inheritance diagram for HestonModel:<p><center><img src="class_quant_lib_1_1_heston_model__inherit__graph.png" border="0" usemap="#_heston_model__inherit__map" alt="Inheritance graph"></center>
<map name="_heston_model__inherit__map">
<area href="class_quant_lib_1_1_bates_model.html" shape="rect" coords="53,231,155,255" alt="">
<area href="class_quant_lib_1_1_calibrated_model.html" shape="rect" coords="39,81,169,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_heston_model-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Heston model for the stochastic volatility of an asset.
<p>
References:<p>
Heston, Steven L., 1993. A Closed-Form Solution for Options with Stochastic Volatility with Applications to <a class="el" href="class_quant_lib_1_1_bond.html">Bond</a> and <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> Options. The review of Financial Studies, Volume 6, Issue 2, 327-343.<p>
<dl compact><dt><b><a class="el" href="test.html#_test000116">Tests:</a></b></dt><dd>calibration is tested against known good values. </dd></dl>
<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="e97050524301ec4c399a197e447dbd4f"></a><!-- doxytag: member="QuantLib::HestonModel::HestonModel" ref="e97050524301ec4c399a197e447dbd4f" args="(const boost::shared_ptr< HestonProcess > &process)" -->
</td><td class="memItemRight" valign="bottom"><b>HestonModel</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_heston_process.html">HestonProcess</a> > &process)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="211532127d83c15b17647a043e9efd36"></a><!-- doxytag: member="QuantLib::HestonModel::theta" ref="211532127d83c15b17647a043e9efd36" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>theta</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d88e3ab524ca113ef0aed0c85918b1f2"></a><!-- doxytag: member="QuantLib::HestonModel::kappa" ref="d88e3ab524ca113ef0aed0c85918b1f2" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>kappa</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bf7456c7feee4fc5c40c1ea775619de"></a><!-- doxytag: member="QuantLib::HestonModel::sigma" ref="3bf7456c7feee4fc5c40c1ea775619de" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>sigma</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="891ea127047dcd9acc1dff3dbf26e88e"></a><!-- doxytag: member="QuantLib::HestonModel::rho" ref="891ea127047dcd9acc1dff3dbf26e88e" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>rho</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b9537c785da7b6872482fee29cfb731"></a><!-- doxytag: member="QuantLib::HestonModel::v0" ref="8b9537c785da7b6872482fee29cfb731" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>v0</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9e93f865f0b5ffac14e1a6dbaf1f197"></a><!-- doxytag: member="QuantLib::HestonModel::tree" ref="a9e93f865f0b5ffac14e1a6dbaf1f197" args="(const TimeGrid &) const" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_numerical_method.html">NumericalMethod</a> > </td><td class="memItemRight" valign="bottom"><b>tree</b> (const <a class="el" href="class_quant_lib_1_1_time_grid.html">TimeGrid</a> &) const</td></tr>
</table>
</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>
|