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
|
<!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>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="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_heston_model.html">HestonModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">HestonModel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::HestonModel" --><!-- doxytag: inherits="QuantLib::CalibratedModel" -->
<p>Heston model for the stochastic volatility of an asset.
<a href="class_quant_lib_1_1_heston_model.html#details">More...</a></p>
<p><code>#include <ql/models/equity/hestonmodel.hpp></code></p>
<div class="dynheader">
Inheritance diagram for HestonModel:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_heston_model__inherit__graph.png" border="0" usemap="#_heston_model_inherit__map" alt="Inheritance graph"/></div>
<map name="_heston_model_inherit__map" id="_heston_model_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_bates_model.html" title="Bates stochastic-volatility model." alt="" coords="17,166,108,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_calibrated_model.html" title="Calibrated model class." alt="" coords="5,6,120,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_heston_model-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="ae97050524301ec4c399a197e447dbd4f"></a><!-- doxytag: member="QuantLib::HestonModel::HestonModel" ref="ae97050524301ec4c399a197e447dbd4f" 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" align="right" valign="top"><a class="anchor" id="a7a00901daf5bbc66f00e4772cbe0c98f"></a><!-- doxytag: member="QuantLib::HestonModel::theta" ref="a7a00901daf5bbc66f00e4772cbe0c98f" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>theta</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a925b952838ecbba1d743cab564c69dc9"></a><!-- doxytag: member="QuantLib::HestonModel::kappa" ref="a925b952838ecbba1d743cab564c69dc9" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>kappa</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78bca11664a7d403bde6a9842f72ae61"></a><!-- doxytag: member="QuantLib::HestonModel::sigma" ref="a78bca11664a7d403bde6a9842f72ae61" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>sigma</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e74bed9ddc465f1211381d725c945bb"></a><!-- doxytag: member="QuantLib::HestonModel::rho" ref="a9e74bed9ddc465f1211381d725c945bb" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>rho</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30fd40988a93faccca807dd016f8c5e3"></a><!-- doxytag: member="QuantLib::HestonModel::v0" ref="a30fd40988a93faccca807dd016f8c5e3" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>v0</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e932938bc12589eb93ad22a7402d2e"></a><!-- doxytag: member="QuantLib::HestonModel::process" ref="a57e932938bc12589eb93ad22a7402d2e" args="() const " -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_heston_process.html">HestonProcess</a> > </td><td class="memItemRight" valign="bottom"><b>process</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d8a7e8e132cf1dd8d1d9eac02f2bfae"></a><!-- doxytag: member="QuantLib::HestonModel::generateArguments" ref="a4d8a7e8e132cf1dd8d1d9eac02f2bfae" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>generateArguments</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a913c0bb126440b8eebb19cb20ed021a2"></a><!-- doxytag: member="QuantLib::HestonModel::process_" ref="a913c0bb126440b8eebb19cb20ed021a2" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_heston_process.html">HestonProcess</a> > </td><td class="memItemRight" valign="bottom"><b>process_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Heston model for the stochastic volatility of an asset. </p>
<p>References:</p>
<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" title="Base bond class.">Bond</a> and <a class="el" href="class_quant_lib_1_1_currency.html" title="Currency specification">Currency</a> Options. The review of Financial Studies, Volume 6, Issue 2, 327-343.</p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000083">Tests:</a></b></dt><dd>calibration is tested against known good values. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_equity_option_8cpp-example.html#_a28">EquityOption.cpp</a>.</dd>
</dl></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>
|