File: class_quant_lib_1_1_hybrid_heston_hull_white_process.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (138 lines) | stat: -rw-r--r-- 9,425 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
<!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: HybridHestonHullWhiteProcess 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_hybrid_heston_hull_white_process.html">HybridHestonHullWhiteProcess</a></div>
<h1>HybridHestonHullWhiteProcess Class Reference<br>
<small>
[<a class="el" href="group__processes.html">Stochastic processes</a>]</small>
</h1><!-- doxytag: class="QuantLib::HybridHestonHullWhiteProcess" --><!-- doxytag: inherits="QuantLib::JointStochasticProcess" --><code>#include &lt;ql/processes/hybridhestonhullwhiteprocess.hpp&gt;</code>
<p>
Inherits JointStochasticProcess.
<p>

<p>
<a href="class_quant_lib_1_1_hybrid_heston_hull_white_process-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Hybrid Heston Hull-White stochastic process. 
<p>
This class implements a three factor Heston Hull-White model<p>
<dl compact><dt><b><a class="el" href="bug.html#_bug000012">Bug:</a></b></dt><dd>This class was not tested enough to guarantee its functionality... work in progress</dd></dl>
<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="22014195af802217bcaa22fa34e8665d"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::HybridHestonHullWhiteProcess" ref="22014195af802217bcaa22fa34e8665d" args="(const boost::shared_ptr&lt; HestonProcess &gt; &amp;hestonProcess, const boost::shared_ptr&lt; HullWhiteForwardProcess &gt; &amp;hullWhiteProcess, Real corrEquityShortRate, Size factors)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>HybridHestonHullWhiteProcess</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_heston_process.html">HestonProcess</a> &gt; &amp;hestonProcess, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_hull_white_forward_process.html">HullWhiteForwardProcess</a> &gt; &amp;hullWhiteProcess, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> corrEquityShortRate, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> factors)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a14251849286df764c0654e8521f39e"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::preEvolve" ref="1a14251849286df764c0654e8521f39e" args="(Time t0, const Array &amp;x0, Time dt, const Array &amp;dw) const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>preEvolve</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x0, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> dt, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;dw) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2bd927d17d98b8bf3a25780fc8c17f8"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::postEvolve" ref="d2bd927d17d98b8bf3a25780fc8c17f8" args="(Time t0, const Array &amp;x0, Time dt, const Array &amp;dw, const Array &amp;y0) const " -->
<a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>postEvolve</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x0, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> dt, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;dw, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;y0) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4565aca1dd76a65766425e5fb55dbcd9"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::numeraire" ref="4565aca1dd76a65766425e5fb55dbcd9" args="(Time t, const Array &amp;x) const " -->
<a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>numeraire</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6389f8dc2ae45cba76a548b62307269"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::correlationIsStateDependent" ref="e6389f8dc2ae45cba76a548b62307269" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>correlationIsStateDependent</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59ee918da29b3d405b18b9883d91ca6d"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::crossModelCorrelation" ref="59ee918da29b3d405b18b9883d91ca6d" args="(Time t0, const Array &amp;x0) const " -->
<a class="el" href="class_quant_lib_1_1_disposable.html">Disposable</a>&lt; <a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>crossModelCorrelation</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t0, const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;x0) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_hybrid_heston_hull_white_process.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::HybridHestonHullWhiteProcess::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>&nbsp;)&nbsp;</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>