File: class_quant_lib_1_1_jarrow_rudd.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 (175 lines) | stat: -rw-r--r-- 18,553 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
169
170
171
172
173
174
175
<!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: JarrowRudd 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_jarrow_rudd.html">JarrowRudd</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_quant_lib_1_1_jarrow_rudd-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">JarrowRudd Class Reference<div class="ingroups"><a class="el" href="group__lattices.html">Lattice methods</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Jarrow-Rudd (multiplicative) equal probabilities binomial tree.  
 <a href="class_quant_lib_1_1_jarrow_rudd.html#details">More...</a></p>

<p><code>#include &lt;ql/methods/lattices/binomialtree.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 JarrowRudd:</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_jarrow_rudd__inherit__graph.png" border="0" usemap="#a_jarrow_rudd_inherit__map" alt="Inheritance graph"/></div>
<map name="_jarrow_rudd_inherit__map" id="a_jarrow_rudd_inherit__map">
<area shape="rect" title="Jarrow&#45;Rudd (multiplicative) equal probabilities binomial tree." alt="" coords="55,169,147,196"/>
<area shape="rect" href="class_quant_lib_1_1_equal_probabilities_binomial_tree.html" title=" " alt="" coords="13,80,189,121"/>
<area shape="rect" href="class_quant_lib_1_1_binomial_tree.html" title=" " alt="" coords="5,5,197,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:a010415e2c4b1b46a439c4597ad5c4dd4"><td class="memItemLeft" align="right" valign="top"><a id="a010415e2c4b1b46a439c4597ad5c4dd4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>JarrowRudd</b> (const ext::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html">StochasticProcess1D</a> &gt; &amp;, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> end, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> steps, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike)</td></tr>
<tr class="separator:a010415e2c4b1b46a439c4597ad5c4dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_equal_probabilities_binomial_tree.html">EqualProbabilitiesBinomialTree&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:a3cba443436190dbcec7cc34d18e819fb inherit pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a3cba443436190dbcec7cc34d18e819fb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>EqualProbabilitiesBinomialTree</b> (const ext::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 class="separator:a3cba443436190dbcec7cc34d18e819fb inherit pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c660cefba93734dec67bf2180b51689 inherit pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a9c660cefba93734dec67bf2180b51689"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>underlying</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> i, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> index) const</td></tr>
<tr class="separator:a9c660cefba93734dec67bf2180b51689 inherit pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e8fd9ff9a63c0e5fd5fb738e3eb6c54 inherit pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a8e8fd9ff9a63c0e5fd5fb738e3eb6c54"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>probability</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>) const</td></tr>
<tr class="separator:a8e8fd9ff9a63c0e5fd5fb738e3eb6c54 inherit pub_methods_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_binomial_tree"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_binomial_tree')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_binomial_tree.html">BinomialTree&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:a958029f8dc7ab003bebae560e2e7f14f inherit pub_methods_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a958029f8dc7ab003bebae560e2e7f14f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BinomialTree</b> (const ext::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 class="separator:a958029f8dc7ab003bebae560e2e7f14f inherit pub_methods_class_quant_lib_1_1_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb4f25e4b90d3059100df693c425563f inherit pub_methods_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="aeb4f25e4b90d3059100df693c425563f"></a>
<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 class="separator:aeb4f25e4b90d3059100df693c425563f inherit pub_methods_class_quant_lib_1_1_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eee154afd6c5287ac501c8271229427 inherit pub_methods_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a2eee154afd6c5287ac501c8271229427"></a>
<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 class="separator:a2eee154afd6c5287ac501c8271229427 inherit pub_methods_class_quant_lib_1_1_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_tree"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_tree')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_tree.html">Tree&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:a8fe1055f39c1f80fd420458fe249fd99 inherit pub_methods_class_quant_lib_1_1_tree"><td class="memItemLeft" align="right" valign="top"><a id="a8fe1055f39c1f80fd420458fe249fd99"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Tree</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> columns)</td></tr>
<tr class="separator:a8fe1055f39c1f80fd420458fe249fd99 inherit pub_methods_class_quant_lib_1_1_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86a771d47cf764c4ef43aab250442fda inherit pub_methods_class_quant_lib_1_1_tree"><td class="memItemLeft" align="right" valign="top"><a id="a86a771d47cf764c4ef43aab250442fda"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>columns</b> () const</td></tr>
<tr class="separator:a86a771d47cf764c4ef43aab250442fda inherit pub_methods_class_quant_lib_1_1_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_quant_lib_1_1_binomial_tree"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_quant_lib_1_1_binomial_tree')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_quant_lib_1_1_binomial_tree.html">BinomialTree&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:a617aa1e32f64a3e471e0facc2b9c63f0 inherit pub_types_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a617aa1e32f64a3e471e0facc2b9c63f0"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Branches</b> </td></tr>
<tr class="separator:a617aa1e32f64a3e471e0facc2b9c63f0 inherit pub_types_class_quant_lib_1_1_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_class_quant_lib_1_1_curiously_recurring_template"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_quant_lib_1_1_curiously_recurring_template')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_quant_lib_1_1_curiously_recurring_template.html">CuriouslyRecurringTemplate&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:af644e65b081eafdcfdf59fed1e0d50ff inherit pro_methods_class_quant_lib_1_1_curiously_recurring_template"><td class="memItemLeft" align="right" valign="top"><a id="af644e65b081eafdcfdf59fed1e0d50ff"></a>
<a class="el" href="class_quant_lib_1_1_jarrow_rudd.html">JarrowRudd</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>impl</b> ()</td></tr>
<tr class="separator:af644e65b081eafdcfdf59fed1e0d50ff inherit pro_methods_class_quant_lib_1_1_curiously_recurring_template"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a347ce8909f609d980047e6d1a8c6c444 inherit pro_methods_class_quant_lib_1_1_curiously_recurring_template"><td class="memItemLeft" align="right" valign="top"><a id="a347ce8909f609d980047e6d1a8c6c444"></a>
const <a class="el" href="class_quant_lib_1_1_jarrow_rudd.html">JarrowRudd</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>impl</b> () const</td></tr>
<tr class="separator:a347ce8909f609d980047e6d1a8c6c444 inherit pro_methods_class_quant_lib_1_1_curiously_recurring_template"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_equal_probabilities_binomial_tree')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_equal_probabilities_binomial_tree.html">EqualProbabilitiesBinomialTree&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:a6bdba80dd07eadaa79cdc7afceee47dd inherit pro_attribs_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a6bdba80dd07eadaa79cdc7afceee47dd"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>up_</b></td></tr>
<tr class="separator:a6bdba80dd07eadaa79cdc7afceee47dd inherit pro_attribs_class_quant_lib_1_1_equal_probabilities_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_binomial_tree"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_binomial_tree')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_binomial_tree.html">BinomialTree&lt; JarrowRudd &gt;</a></td></tr>
<tr class="memitem:afb597b35edab96eecbcbf9a2df04f05d inherit pro_attribs_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="afb597b35edab96eecbcbf9a2df04f05d"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>x0_</b></td></tr>
<tr class="separator:afb597b35edab96eecbcbf9a2df04f05d inherit pro_attribs_class_quant_lib_1_1_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f3db9657071c9b664b10313f33717ca inherit pro_attribs_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a1f3db9657071c9b664b10313f33717ca"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>driftPerStep_</b></td></tr>
<tr class="separator:a1f3db9657071c9b664b10313f33717ca inherit pro_attribs_class_quant_lib_1_1_binomial_tree"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6be603d8547f31e72817d2aaf219e325 inherit pro_attribs_class_quant_lib_1_1_binomial_tree"><td class="memItemLeft" align="right" valign="top"><a id="a6be603d8547f31e72817d2aaf219e325"></a>
<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dt_</b></td></tr>
<tr class="separator:a6be603d8547f31e72817d2aaf219e325 inherit pro_attribs_class_quant_lib_1_1_binomial_tree"><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>Jarrow-Rudd (multiplicative) equal probabilities binomial tree. </p>
</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>