File: class_quant_lib_1_1_lfm_hull_white_parameterization.html

package info (click to toggle)
quantlib-refman-html 1.20-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 103,140 kB
  • sloc: javascript: 13,408; makefile: 35
file content (168 lines) | stat: -rw-r--r-- 15,774 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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: LfmHullWhiteParameterization Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://quantlib.org">
       <img alt="QuantLib" src="QL-title.jpg"></a>
   <div id="projectbrief">A free/open-source library for quantitative finance</div>
   <div id="projectnumber">Reference manual - version 1.20</div>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_lfm_hull_white_parameterization.html">LfmHullWhiteParameterization</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_quant_lib_1_1_lfm_hull_white_parameterization-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">LfmHullWhiteParameterization Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Libor market model parameterization based on Hull White paper  
 <a href="class_quant_lib_1_1_lfm_hull_white_parameterization.html#details">More...</a></p>

<p><code>#include &lt;ql/legacy/libormarketmodels/lfmhullwhiteparam.hpp&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for LfmHullWhiteParameterization:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_quant_lib_1_1_lfm_hull_white_parameterization__inherit__graph.png" border="0" usemap="#a_lfm_hull_white_parameterization_inherit__map" alt="Inheritance graph"/></div>
<map name="_lfm_hull_white_parameterization_inherit__map" id="a_lfm_hull_white_parameterization_inherit__map">
<area shape="rect" title="Libor market model parameterization based on Hull White paper" alt="" coords="10,80,209,107"/>
<area shape="rect" href="class_quant_lib_1_1_lfm_covariance_parameterization.html" title="Libor market model parameterization" alt="" coords="5,5,213,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abef2d43a520b7595400654ac14d71936"><td class="memItemLeft" align="right" valign="top"><a id="abef2d43a520b7595400654ac14d71936"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LfmHullWhiteParameterization</b> (const ext::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_libor_forward_model_process.html">LiborForwardModelProcess</a> &gt; &amp;process, const ext::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_optionlet_volatility_structure.html">OptionletVolatilityStructure</a> &gt; &amp;capletVol, const <a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a> &amp;correlation=<a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a>(), <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> factors=1)</td></tr>
<tr class="separator:abef2d43a520b7595400654ac14d71936"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8276f92bbf8404e6a314f370ac6c360a"><td class="memItemLeft" align="right" valign="top"><a id="a8276f92bbf8404e6a314f370ac6c360a"></a>
<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;&#160;</td><td class="memItemRight" valign="bottom"><b>diffusion</b> (<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> &amp;x=<a class="el" href="class_quant_lib_1_1_null.html">Null</a>&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;()) const</td></tr>
<tr class="separator:a8276f92bbf8404e6a314f370ac6c360a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4979bb8ad104746a3b8f0192ec941f57"><td class="memItemLeft" align="right" valign="top"><a id="a4979bb8ad104746a3b8f0192ec941f57"></a>
<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;&#160;</td><td class="memItemRight" valign="bottom"><b>covariance</b> (<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> &amp;x=<a class="el" href="class_quant_lib_1_1_null.html">Null</a>&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;()) const</td></tr>
<tr class="separator:a4979bb8ad104746a3b8f0192ec941f57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26b2035a5d3c6417fa2ab0d3cbb4e95b"><td class="memItemLeft" align="right" valign="top"><a id="a26b2035a5d3c6417fa2ab0d3cbb4e95b"></a>
<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;&#160;</td><td class="memItemRight" valign="bottom"><b>integratedCovariance</b> (<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> &amp;x=<a class="el" href="class_quant_lib_1_1_null.html">Null</a>&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;()) const</td></tr>
<tr class="separator:a26b2035a5d3c6417fa2ab0d3cbb4e95b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_lfm_covariance_parameterization.html">LfmCovarianceParameterization</a></td></tr>
<tr class="memitem:a28186f7bbcc9ede01363ab8bf7a70d44 inherit pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memItemLeft" align="right" valign="top"><a id="a28186f7bbcc9ede01363ab8bf7a70d44"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LfmCovarianceParameterization</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> size, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> factors)</td></tr>
<tr class="separator:a28186f7bbcc9ede01363ab8bf7a70d44 inherit pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acce0ab2cacc475b2434f24c65c91685a inherit pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memItemLeft" align="right" valign="top"><a id="acce0ab2cacc475b2434f24c65c91685a"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="separator:acce0ab2cacc475b2434f24c65c91685a inherit pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80d7c2dfc8a2fa937425f38ce5cacd41 inherit pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memItemLeft" align="right" valign="top"><a id="a80d7c2dfc8a2fa937425f38ce5cacd41"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>factors</b> () const</td></tr>
<tr class="separator:a80d7c2dfc8a2fa937425f38ce5cacd41 inherit pub_methods_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aafdc0422de53565b9381e254f14787c5"><td class="memItemLeft" align="right" valign="top"><a id="aafdc0422de53565b9381e254f14787c5"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>nextIndexReset</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const</td></tr>
<tr class="separator:aafdc0422de53565b9381e254f14787c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9e55213e724d95c783519226f9931af7"><td class="memItemLeft" align="right" valign="top"><a id="a9e55213e724d95c783519226f9931af7"></a>
<a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a>&#160;</td><td class="memItemRight" valign="bottom"><b>diffusion_</b></td></tr>
<tr class="separator:a9e55213e724d95c783519226f9931af7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c4a5f11b286a206fe151fbc131b6dd0"><td class="memItemLeft" align="right" valign="top"><a id="a3c4a5f11b286a206fe151fbc131b6dd0"></a>
<a class="el" href="class_quant_lib_1_1_matrix.html">Matrix</a>&#160;</td><td class="memItemRight" valign="bottom"><b>covariance_</b></td></tr>
<tr class="separator:a3c4a5f11b286a206fe151fbc131b6dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8d80d95c018986943e14d484b6ff9c6"><td class="memItemLeft" align="right" valign="top"><a id="ab8d80d95c018986943e14d484b6ff9c6"></a>
std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>fixingTimes_</b></td></tr>
<tr class="separator:ab8d80d95c018986943e14d484b6ff9c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_lfm_covariance_parameterization"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_lfm_covariance_parameterization')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_lfm_covariance_parameterization.html">LfmCovarianceParameterization</a></td></tr>
<tr class="memitem:a6bc74a91ed4c6cb51d2fa5b1f8cdaf60 inherit pro_attribs_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memItemLeft" align="right" valign="top"><a id="a6bc74a91ed4c6cb51d2fa5b1f8cdaf60"></a>
const <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size_</b></td></tr>
<tr class="separator:a6bc74a91ed4c6cb51d2fa5b1f8cdaf60 inherit pro_attribs_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19357300f903f9594909f2aa2c729ac5 inherit pro_attribs_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memItemLeft" align="right" valign="top"><a id="a19357300f903f9594909f2aa2c729ac5"></a>
const <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>factors_</b></td></tr>
<tr class="separator:a19357300f903f9594909f2aa2c729ac5 inherit pro_attribs_class_quant_lib_1_1_lfm_covariance_parameterization"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Libor market model parameterization based on Hull White paper </p>
<p>Hull, John, White, Alan, 1999, <a class="el" href="class_quant_lib_1_1_forward.html" title="Abstract base forward class.">Forward</a> Rate Volatilities, <a class="el" href="class_quant_lib_1_1_swap.html" title="Interest rate swap.">Swap</a> Rate Volatilities and the Implementation of the <a class="el" href="class_quant_lib_1_1_libor.html" title="base class for all ICE LIBOR indexes but the EUR, O/N, and S/N ones">Libor</a> Market Model (<a href="http://www.rotman.utoronto.ca/~amackay/fin/libormktmodel2.pdf">http://www.rotman.utoronto.ca/~amackay/fin/libormktmodel2.pdf</a>)</p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000031">Tests:</a></b></dt><dd>the correctness is tested by Monte-Carlo reproduction of caplet &amp; ratchet npvs and comparison with Black pricing. </dd></dl>
</div></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>