File: class_quant_lib_1_1_analytic_heston_hull_white_engine.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (151 lines) | stat: -rw-r--r-- 10,298 bytes parent folder | download
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
<!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>AnalyticHestonHullWhiteEngine 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_analytic_heston_hull_white_engine.html">AnalyticHestonHullWhiteEngine</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">AnalyticHestonHullWhiteEngine Class Reference<div class="ingroups"><a class="el" href="group__vanillaengines.html">Vanilla option engines</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::AnalyticHestonHullWhiteEngine" --><!-- doxytag: inherits="QuantLib::AnalyticHestonEngine" -->
<p>Analytic Heston engine incl. stochastic interest rates.  
 <a href="class_quant_lib_1_1_analytic_heston_hull_white_engine.html#details">More...</a></p>

<p><code>#include &lt;ql/pricingengines/vanilla/analytichestonhullwhiteengine.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for AnalyticHestonHullWhiteEngine:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_analytic_heston_hull_white_engine__inherit__graph.png" border="0" usemap="#_analytic_heston_hull_white_engine_inherit__map" alt="Inheritance graph"/></div>
<map name="_analytic_heston_hull_white_engine_inherit__map" id="_analytic_heston_hull_white_engine_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_analytic_heston_engine.html" title="analytic Heston&#45;model engine based on Fourier transform" alt="" coords="32,6,181,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_analytic_heston_hull_white_engine-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="a9b18a1700c3a0da0247e508f00f28dac"></a><!-- doxytag: member="QuantLib::AnalyticHestonHullWhiteEngine::AnalyticHestonHullWhiteEngine" ref="a9b18a1700c3a0da0247e508f00f28dac" args="(const boost::shared_ptr&lt; HestonModel &gt; &amp;hestonModel, const boost::shared_ptr&lt; HullWhite &gt; &amp;hullWhiteModel, Size integrationOrder=144)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>AnalyticHestonHullWhiteEngine</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_heston_model.html">HestonModel</a> &gt; &amp;hestonModel, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_hull_white.html">HullWhite</a> &gt; &amp;hullWhiteModel, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> integrationOrder=144)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7900b340886e5e832928eed0f7fb576"></a><!-- doxytag: member="QuantLib::AnalyticHestonHullWhiteEngine::AnalyticHestonHullWhiteEngine" ref="aa7900b340886e5e832928eed0f7fb576" args="(const boost::shared_ptr&lt; HestonModel &gt; &amp;model, const boost::shared_ptr&lt; HullWhite &gt; &amp;hullWhiteModel, Real relTolerance, Size maxEvaluations)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>AnalyticHestonHullWhiteEngine</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_heston_model.html">HestonModel</a> &gt; &amp;model, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_hull_white.html">HullWhite</a> &gt; &amp;hullWhiteModel, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> relTolerance, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> maxEvaluations)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_analytic_heston_hull_white_engine.html#ac5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10873979f635888606e03f9cb2d8a096"></a><!-- doxytag: member="QuantLib::AnalyticHestonHullWhiteEngine::calculate" ref="a10873979f635888606e03f9cb2d8a096" args="() const " -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>calculate</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="a406a77cd82a42a93cdcd5d292f17bfd0"></a><!-- doxytag: member="QuantLib::AnalyticHestonHullWhiteEngine::addOnTerm" ref="a406a77cd82a42a93cdcd5d292f17bfd0" args="(Real phi, Time t, Size j) const " -->
std::complex&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>addOnTerm</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> phi, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> j) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Analytic Heston engine incl. stochastic interest rates. </p>
<p>This class is pricing a european options under the following processes</p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ \begin{array}{rcl} dS(t, S) &amp;=&amp; (r-d) S dt +\sqrt{v} S dW_1 \\ dv(t, S) &amp;=&amp; \kappa (\theta - v) dt + \sigma \sqrt{v} dW_2 \\ dr(t) &amp;=&amp; (\theta(t) - a r) dt + \eta dW_3 \\ dW_1 dW_2 &amp;=&amp; \rho dt \\ dW_1 dW_3 &amp;=&amp; 0 \\ dW_2 dW_3 &amp;=&amp; 0 \\ \end{array} \]" src="form_321.png"/>
</p>
<p>References:</p>
<p>Karel in't Hout, Joris Bierkens, Antoine von der Ploeg, Joe in't Panhuis, A Semi closed-from analytic pricing formula for call options in a hybrid Heston-Hull-White Model.</p>
<p>A. Sepp, Pricing European-Style Options under Jump Diffusion Processes with Stochastic Volatility: Applications of Fourier Transform (&lt;<a href="http://math.ut.ee/~spartak/papers/stochjumpvols.pdf">http://math.ut.ee/~spartak/papers/stochjumpvols.pdf</a>&gt;)</p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000117">Tests:</a></b></dt><dd>the correctness of the returned value is tested by reproducing results available in web/literature, testing against QuantLib's analytic Heston and Black-Scholes-Merton Hull-White engine </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::AnalyticHestonHullWhiteEngine::update" ref="ac5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_analytic_heston_hull_white_engine.html#ac5c54df7ed3b930268c8d7752c101725">update</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><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>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_generic_engine.html#ac5c54df7ed3b930268c8d7752c101725">GenericEngine&lt; VanillaOption::arguments, VanillaOption::results &gt;</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>