File: class_quant_lib_1_1_extended_binomial_tree.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 (142 lines) | stat: -rw-r--r-- 9,646 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
<!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>ExtendedBinomialTree&lt; T &gt; 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="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_extended_binomial_tree.html">ExtendedBinomialTree</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<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">ExtendedBinomialTree&lt; T &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__lattices.html">Lattice methods</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ExtendedBinomialTree" --><!-- doxytag: inherits="QuantLib::Tree" -->
<p>Binomial tree base class.  
 <a href="class_quant_lib_1_1_extended_binomial_tree.html#details">More...</a></p>

<p><code>#include &lt;ql/experimental/lattices/extendedbinomialtree.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ExtendedBinomialTree&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_extended_binomial_tree__inherit__graph.png" border="0" usemap="#_extended_binomial_tree_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_extended_binomial_tree_3_01_t_01_4_inherit__map" id="_extended_binomial_tree_3_01_t_01_4_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_extended_equal_jumps_binomial_tree.html" title="Base class for equal jumps binomial tree." alt="" coords="5,166,259,197"/><area shape="rect" id="node7" href="class_quant_lib_1_1_extended_equal_probabilities_binomial_tree.html" title="Base class for equal probabilities binomial tree." alt="" coords="283,166,571,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_tree.html" title="Tree approximating a single&#45;factor diffusion" alt="" coords="240,6,317,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_extended_binomial_tree-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>Branches</b> { <b>branches</b> =  2
 }</td></tr>
<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="a8c0340599fce1f3727ff13158499561f"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::ExtendedBinomialTree" ref="a8c0340599fce1f3727ff13158499561f" args="(const boost::shared_ptr&lt; StochasticProcess1D &gt; &amp;process, Time end, Size steps)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ExtendedBinomialTree</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html">StochasticProcess1D</a> &gt; &amp;process, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> end, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> steps)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2609b991dbefe939a4749c7cb101fcb5"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::size" ref="a2609b991dbefe939a4749c7cb101fcb5" args="(Size i) const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab3e236871d755fdfdd7c3dd22c52f9c"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::descendant" ref="aab3e236871d755fdfdd7c3dd22c52f9c" args="(Size, Size index, Size branch) const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>descendant</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> index, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> branch) 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="a418855fb649d39b9d5722320dd8f932d"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::driftStep" ref="a418855fb649d39b9d5722320dd8f932d" args="(Time driftTime) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>driftStep</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> driftTime) 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="afb597b35edab96eecbcbf9a2df04f05d"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::x0_" ref="afb597b35edab96eecbcbf9a2df04f05d" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>x0_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f3db9657071c9b664b10313f33717ca"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::driftPerStep_" ref="a1f3db9657071c9b664b10313f33717ca" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>driftPerStep_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6be603d8547f31e72817d2aaf219e325"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::dt_" ref="a6be603d8547f31e72817d2aaf219e325" args="" -->
<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dt_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1451aa584df31b64735d46fe9190cca6"></a><!-- doxytag: member="QuantLib::ExtendedBinomialTree::treeProcess_" ref="a1451aa584df31b64735d46fe9190cca6" args="" -->
boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html">StochasticProcess1D</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>treeProcess_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br/>
class QuantLib::ExtendedBinomialTree&lt; T &gt;</h3>

<p>Binomial tree base class. </p>
</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>