File: class_quant_lib_1_1_lattice2_d.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 (146 lines) | stat: -rw-r--r-- 7,885 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
<!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: Lattice2D Class Template 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_lattice2_d.html">Lattice2D</a></div>
<h1>Lattice2D Class Template Reference<br>
<small>
[<a class="el" href="group__lattices.html">Lattice methods</a>]</small>
</h1><!-- doxytag: class="QuantLib::Lattice2D" --><!-- doxytag: inherits="QuantLib::Lattice" --><code>#include &lt;ql/Lattices/lattice2d.hpp&gt;</code>
<p>
Inheritance diagram for Lattice2D:<p><center><img src="class_quant_lib_1_1_lattice2_d__inherit__graph.png" border="0" usemap="#_lattice2_d__inherit__map" alt="Inheritance graph"></center>
<map name="_lattice2_d__inherit__map">
<area href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_tree.html" shape="rect" coords="5,231,603,255" alt="">
<area href="class_quant_lib_1_1_lattice.html" shape="rect" coords="240,81,368,105" alt="">
<area href="class_quant_lib_1_1_numerical_method.html" shape="rect" coords="119,7,260,31" alt="">
<area href="class_quant_lib_1_1_curiously_recurring_template.html" shape="rect" coords="284,7,556,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_lattice2_d-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class Impl, class T = TrinomialTree&gt;<br>
 class QuantLib::Lattice2D&lt; Impl, T &gt;</h3>

Two-dimensional lattice. 
<p>
This lattice is based on two trinomial trees and primarily used for the <a class="el" href="class_quant_lib_1_1_g2.html">G2</a> short-rate model. 
<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="ac921bcaab0754dcef3460b3a2bd2648"></a><!-- doxytag: member="QuantLib::Lattice2D::Lattice2D" ref="ac921bcaab0754dcef3460b3a2bd2648" args="(const boost::shared_ptr&lt; T &gt; &amp;tree1, const boost::shared_ptr&lt; T &gt; &amp;tree2, Real correlation)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Lattice2D</b> (const boost::shared_ptr&lt; T &gt; &amp;tree1, const boost::shared_ptr&lt; T &gt; &amp;tree2, Real correlation)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb4f25e4b90d3059100df693c425563f"></a><!-- doxytag: member="QuantLib::Lattice2D::size" ref="eb4f25e4b90d3059100df693c425563f" args="(Size i) const" -->
Size&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> (Size i) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="460df55f2a51ce5a7381cc0dfb2aa12a"></a><!-- doxytag: member="QuantLib::Lattice2D::descendant" ref="460df55f2a51ce5a7381cc0dfb2aa12a" args="(Size i, Size index, Size branch) const" -->
Size&nbsp;</td><td class="memItemRight" valign="bottom"><b>descendant</b> (Size i, Size index, Size branch) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="886717e8df5ff198a2c8463d0e4193ed"></a><!-- doxytag: member="QuantLib::Lattice2D::probability" ref="886717e8df5ff198a2c8463d0e4193ed" args="(Size i, Size index, Size branch) const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>probability</b> (Size i, Size index, Size branch) const</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6796fbe0767aa5f4a6f8817190a9d30"></a><!-- doxytag: member="QuantLib::Lattice2D::grid" ref="f6796fbe0767aa5f4a6f8817190a9d30" args="(Time) 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>grid</b> (Time) const</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="caea9adf32c44af8f5148eb9ae443ee3"></a><!-- doxytag: member="QuantLib::Lattice2D::tree1_" ref="caea9adf32c44af8f5148eb9ae443ee3" args="" -->
boost::shared_ptr&lt; T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>tree1_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68d62c140de156a0986f384781c3f861"></a><!-- doxytag: member="QuantLib::Lattice2D::tree2_" ref="68d62c140de156a0986f384781c3f861" args="" -->
boost::shared_ptr&lt; T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>tree2_</b></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>