File: class_quant_lib_1_1_lfm_hull_white_parameterization.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 (135 lines) | stat: -rw-r--r-- 10,838 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
<!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>LfmHullWhiteParameterization 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_lfm_hull_white_parameterization.html">LfmHullWhiteParameterization</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> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">LfmHullWhiteParameterization Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::LfmHullWhiteParameterization" --><!-- doxytag: inherits="QuantLib::LfmCovarianceParameterization" -->
<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 class="dynheader">
Inheritance diagram for LfmHullWhiteParameterization:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_lfm_hull_white_parameterization__inherit__graph.png" border="0" usemap="#_lfm_hull_white_parameterization_inherit__map" alt="Inheritance graph"/></div>
<map name="_lfm_hull_white_parameterization_inherit__map" id="_lfm_hull_white_parameterization_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_lfm_covariance_parameterization.html" title="Libor market model parameterization" alt="" coords="5,6,211,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_lfm_hull_white_parameterization-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="a0a9d92c9beb820af6e0e6379490d2ce9"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::LfmHullWhiteParameterization" ref="a0a9d92c9beb820af6e0e6379490d2ce9" args="(const boost::shared_ptr&lt; LiborForwardModelProcess &gt; &amp;process, const boost::shared_ptr&lt; OptionletVolatilityStructure &gt; &amp;capletVol, const Matrix &amp;correlation=Matrix(), Size factors=1)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>LfmHullWhiteParameterization</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_libor_forward_model_process.html">LiborForwardModelProcess</a> &gt; &amp;process, const boost::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><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98f01d842b650489da3c57e779f73c93"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::diffusion" ref="a98f01d842b650489da3c57e779f73c93" args="(Time t, const Array &amp;x=Null&lt; Array &gt;()) 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;&#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=Null&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;()) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0278d24739a9bfc281246d6172530b49"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::covariance" ref="a0278d24739a9bfc281246d6172530b49" args="(Time t, const Array &amp;x=Null&lt; Array &gt;()) 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;&#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=Null&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;()) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abadf15cf4c8136891d2e91d8f36a0baf"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::integratedCovariance" ref="abadf15cf4c8136891d2e91d8f36a0baf" args="(Time t, const Array &amp;x=Null&lt; Array &gt;()) 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;&#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=Null&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;()) 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="a50e781d78a77b91b09d63af7be8370e7"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::nextIndexReset" ref="a50e781d78a77b91b09d63af7be8370e7" args="(Time t) const " -->
<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><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="a9e55213e724d95c783519226f9931af7"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::diffusion_" ref="a9e55213e724d95c783519226f9931af7" args="" -->
<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><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c4a5f11b286a206fe151fbc131b6dd0"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::covariance_" ref="a3c4a5f11b286a206fe151fbc131b6dd0" args="" -->
<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><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8d80d95c018986943e14d484b6ff9c6"></a><!-- doxytag: member="QuantLib::LfmHullWhiteParameterization::fixingTimes_" ref="ab8d80d95c018986943e14d484b6ff9c6" args="" -->
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>
</table>
<hr/><a name="details" id="details"></a><h2>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 BBA LIBOR indexes but the EUR, O/N, and S/N ones">Libor</a> Market Model (&lt;<a href="http://www.rotman.utoronto.ca/~amackay/fin/libormktmodel2.pdf">http://www.rotman.utoronto.ca/~amackay/fin/libormktmodel2.pdf</a>&gt;)</p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000024">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 -->

</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>