File: class_quant_lib_1_1_two_factor_model.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (138 lines) | stat: -rw-r--r-- 7,614 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.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: TwoFactorModel 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_two_factor_model.html">TwoFactorModel</a></div>
<h1>TwoFactorModel Class Reference<br>
<small>
[<a class="el" href="group__shortrate.html">Short-rate modelling framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::TwoFactorModel" --><!-- doxytag: inherits="QuantLib::ShortRateModel" --><code>#include &lt;ql/ShortRateModels/twofactormodel.hpp&gt;</code>
<p>
Inheritance diagram for TwoFactorModel:<p><center><img src="class_quant_lib_1_1_two_factor_model__inherit__graph.png" border="0" usemap="#_two_factor_model__inherit__map" alt="Inheritance graph"></center>
<map name="_two_factor_model__inherit__map">
<area href="class_quant_lib_1_1_g2.html" shape="rect" coords="84,305,124,329" alt="">
<area href="class_quant_lib_1_1_short_rate_model.html" shape="rect" coords="40,156,168,180" alt="">
<area href="class_quant_lib_1_1_calibrated_model.html" shape="rect" coords="39,81,169,105" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="5,7,88,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="112,7,211,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_two_factor_model-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract base-class for two-factor models. 
<p>
<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="b21a4909440df05943ed8035a3cb8ec9"></a><!-- doxytag: member="QuantLib::TwoFactorModel::TwoFactorModel" ref="b21a4909440df05943ed8035a3cb8ec9" args="(Size nParams)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>TwoFactorModel</b> (Size nParams)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31a05ee99de4f96e67defdf4917356"></a><!-- doxytag: member="QuantLib::TwoFactorModel::dynamics" ref="4f31a05ee99de4f96e67defdf4917356" args="() const=0" -->
virtual boost::shared_ptr&lt;<br>
 <a class="el" href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_dynamics.html">ShortRateDynamics</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_two_factor_model.html#4f31a05ee99de4f96e67defdf4917356">dynamics</a> () const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the short-rate dynamics. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="140a7c576c87942d7f5a10db36affe8c"></a><!-- doxytag: member="QuantLib::TwoFactorModel::tree" ref="140a7c576c87942d7f5a10db36affe8c" args="(const TimeGrid &amp;grid) const " -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_numerical_method.html">NumericalMethod</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_two_factor_model.html#140a7c576c87942d7f5a10db36affe8c">tree</a> (const <a class="el" href="class_quant_lib_1_1_time_grid.html">TimeGrid</a> &amp;grid) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a two-dimensional trinomial tree. <br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_dynamics.html">ShortRateDynamics</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class describing the dynamics of the two state variables.  <a href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_dynamics.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_tree.html">ShortRateTree</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Recombining two-dimensional tree discretizing the state variable.  <a href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_tree.html#_details">More...</a><br></td></tr>
</table>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>