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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!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: ExplicitEuler< Operator > Class Template 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&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&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_explicit_euler.html">ExplicitEuler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_quant_lib_1_1_explicit_euler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ExplicitEuler< Operator > Class Template Reference<div class="ingroups"><a class="el" href="group__findiff.html">Finite-differences framework</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Forward Euler scheme for finite difference methods
<a href="class_quant_lib_1_1_explicit_euler.html#details">More...</a></p>
<p><code>#include <ql/methods/finitedifferences/expliciteuler.hpp></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 ExplicitEuler< Operator >:</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_explicit_euler__inherit__graph.png" border="0" usemap="#a_explicit_euler_3_01_operator_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_explicit_euler_3_01_operator_01_4_inherit__map" id="a_explicit_euler_3_01_operator_01_4_inherit__map">
<area shape="rect" title="Forward Euler scheme for finite difference methods" alt="" coords="10,80,179,107"/>
<area shape="rect" href="class_quant_lib_1_1_mixed_scheme.html" title="Mixed (explicit/implicit) scheme for finite difference methods." alt="" coords="5,5,184,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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab85b62c5cc90bded0075d322e91fd993"><td class="memItemLeft" align="right" valign="top"><a id="ab85b62c5cc90bded0075d322e91fd993"></a>
typedef OperatorTraits< Operator > </td><td class="memItemRight" valign="bottom"><b>traits</b></td></tr>
<tr class="separator:ab85b62c5cc90bded0075d322e91fd993"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02ede700df8d04acf392294f6ab090c4"><td class="memItemLeft" align="right" valign="top"><a id="a02ede700df8d04acf392294f6ab090c4"></a>
typedef traits::operator_type </td><td class="memItemRight" valign="bottom"><b>operator_type</b></td></tr>
<tr class="separator:a02ede700df8d04acf392294f6ab090c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac07e755f1412353806d561469c9ad49f"><td class="memItemLeft" align="right" valign="top"><a id="ac07e755f1412353806d561469c9ad49f"></a>
typedef traits::array_type </td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>
<tr class="separator:ac07e755f1412353806d561469c9ad49f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ef2ff2e57a5eb84f1e124859bac8d74"><td class="memItemLeft" align="right" valign="top"><a id="a5ef2ff2e57a5eb84f1e124859bac8d74"></a>
typedef <a class="el" href="class_quant_lib_1_1_boundary_condition.html">traits::bc_type</a> </td><td class="memItemRight" valign="bottom"><b>bc_type</b></td></tr>
<tr class="separator:a5ef2ff2e57a5eb84f1e124859bac8d74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7fb68e182d263712988c9b0afe1ad6a0"><td class="memItemLeft" align="right" valign="top"><a id="a7fb68e182d263712988c9b0afe1ad6a0"></a>
typedef traits::bc_set </td><td class="memItemRight" valign="bottom"><b>bc_set</b></td></tr>
<tr class="separator:a7fb68e182d263712988c9b0afe1ad6a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b68be7f0b8097f723468a930f604c39"><td class="memItemLeft" align="right" valign="top"><a id="a9b68be7f0b8097f723468a930f604c39"></a>
typedef <a class="el" href="class_quant_lib_1_1_step_condition.html">traits::condition_type</a> </td><td class="memItemRight" valign="bottom"><b>condition_type</b></td></tr>
<tr class="separator:a9b68be7f0b8097f723468a930f604c39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_types_class_quant_lib_1_1_mixed_scheme"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_quant_lib_1_1_mixed_scheme')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_quant_lib_1_1_mixed_scheme.html">MixedScheme< Operator ></a></td></tr>
<tr class="memitem:ab85b62c5cc90bded0075d322e91fd993 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="ab85b62c5cc90bded0075d322e91fd993"></a>
typedef OperatorTraits< Operator > </td><td class="memItemRight" valign="bottom"><b>traits</b></td></tr>
<tr class="separator:ab85b62c5cc90bded0075d322e91fd993 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02ede700df8d04acf392294f6ab090c4 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a02ede700df8d04acf392294f6ab090c4"></a>
typedef traits::operator_type </td><td class="memItemRight" valign="bottom"><b>operator_type</b></td></tr>
<tr class="separator:a02ede700df8d04acf392294f6ab090c4 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac07e755f1412353806d561469c9ad49f inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="ac07e755f1412353806d561469c9ad49f"></a>
typedef traits::array_type </td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>
<tr class="separator:ac07e755f1412353806d561469c9ad49f inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7fb68e182d263712988c9b0afe1ad6a0 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a7fb68e182d263712988c9b0afe1ad6a0"></a>
typedef traits::bc_set </td><td class="memItemRight" valign="bottom"><b>bc_set</b></td></tr>
<tr class="separator:a7fb68e182d263712988c9b0afe1ad6a0 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b68be7f0b8097f723468a930f604c39 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a9b68be7f0b8097f723468a930f604c39"></a>
typedef <a class="el" href="class_quant_lib_1_1_step_condition.html">traits::condition_type</a> </td><td class="memItemRight" valign="bottom"><b>condition_type</b></td></tr>
<tr class="separator:a9b68be7f0b8097f723468a930f604c39 inherit pub_types_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a1ffa4a5c585d83729faa0bafa7d96fe6"><td class="memItemLeft" align="right" valign="top"><a id="a1ffa4a5c585d83729faa0bafa7d96fe6"></a>
 </td><td class="memItemRight" valign="bottom"><b>ExplicitEuler</b> (const operator_type &L, const std::vector< ext::shared_ptr< <a class="el" href="class_quant_lib_1_1_boundary_condition.html">bc_type</a> > > &bcs)</td></tr>
<tr class="separator:a1ffa4a5c585d83729faa0bafa7d96fe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_mixed_scheme"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_mixed_scheme')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_mixed_scheme.html">MixedScheme< Operator ></a></td></tr>
<tr class="memitem:a342497546b70b2f83e90a83be8fd5a45 inherit pub_methods_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a342497546b70b2f83e90a83be8fd5a45"></a>
 </td><td class="memItemRight" valign="bottom"><b>MixedScheme</b> (const operator_type &L, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> theta, const bc_set &bcs)</td></tr>
<tr class="separator:a342497546b70b2f83e90a83be8fd5a45 inherit pub_methods_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae31015dcf2ddc4f248be2533b0bbbd95 inherit pub_methods_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="ae31015dcf2ddc4f248be2533b0bbbd95"></a>
void </td><td class="memItemRight" valign="bottom"><b>step</b> (array_type &a, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t)</td></tr>
<tr class="separator:ae31015dcf2ddc4f248be2533b0bbbd95 inherit pub_methods_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c6bf7e1e335626aa6f4e7a46f361b50 inherit pub_methods_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a7c6bf7e1e335626aa6f4e7a46f361b50"></a>
void </td><td class="memItemRight" valign="bottom"><b>setStep</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> dt)</td></tr>
<tr class="separator:a7c6bf7e1e335626aa6f4e7a46f361b50 inherit pub_methods_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </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 pro_attribs_class_quant_lib_1_1_mixed_scheme"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_mixed_scheme')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_mixed_scheme.html">MixedScheme< Operator ></a></td></tr>
<tr class="memitem:a7ec7f35b9cfc993cd78e13c84ee80f5c inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a7ec7f35b9cfc993cd78e13c84ee80f5c"></a>
operator_type </td><td class="memItemRight" valign="bottom"><b>L_</b></td></tr>
<tr class="separator:a7ec7f35b9cfc993cd78e13c84ee80f5c inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9345bcefe07d2a311bb4580cf6844223 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a9345bcefe07d2a311bb4580cf6844223"></a>
operator_type </td><td class="memItemRight" valign="bottom"><b>I_</b></td></tr>
<tr class="separator:a9345bcefe07d2a311bb4580cf6844223 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2dd5907ac54bce1439847d0204c7ca55 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a2dd5907ac54bce1439847d0204c7ca55"></a>
operator_type </td><td class="memItemRight" valign="bottom"><b>explicitPart_</b></td></tr>
<tr class="separator:a2dd5907ac54bce1439847d0204c7ca55 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70be7cca17d458911d7cb37ac568fa80 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a70be7cca17d458911d7cb37ac568fa80"></a>
operator_type </td><td class="memItemRight" valign="bottom"><b>implicitPart_</b></td></tr>
<tr class="separator:a70be7cca17d458911d7cb37ac568fa80 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6be603d8547f31e72817d2aaf219e325 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a6be603d8547f31e72817d2aaf219e325"></a>
<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td><td class="memItemRight" valign="bottom"><b>dt_</b></td></tr>
<tr class="separator:a6be603d8547f31e72817d2aaf219e325 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ca0ebc8ec96d11c5542cd549f01db16 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="a5ca0ebc8ec96d11c5542cd549f01db16"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>theta_</b></td></tr>
<tr class="separator:a5ca0ebc8ec96d11c5542cd549f01db16 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb48456777566e37b094bb898bafc1a7 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memItemLeft" align="right" valign="top"><a id="abb48456777566e37b094bb898bafc1a7"></a>
bc_set </td><td class="memItemRight" valign="bottom"><b>bcs_</b></td></tr>
<tr class="separator:abb48456777566e37b094bb898bafc1a7 inherit pro_attribs_class_quant_lib_1_1_mixed_scheme"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class Operator><br />
class QuantLib::ExplicitEuler< Operator ></h3>
<p>Forward Euler scheme for finite difference methods </p>
<p>See sect. <a class="el" href="group__findiff.html">Finite-differences framework</a> for details on the method.</p>
<p>In this implementation, the passed operator must be derived from either TimeConstantOperator or TimeDependentOperator. Also, it must implement at least the following interface:</p>
<div class="fragment"><div class="line"><span class="keyword">typedef</span> ... array_type;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// copy constructor/assignment</span></div>
<div class="line"><span class="comment">// (these will be provided by the compiler if none is defined)</span></div>
<div class="line">Operator(<span class="keyword">const</span> Operator&);</div>
<div class="line">Operator& operator=(<span class="keyword">const</span> Operator&);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// inspectors</span></div>
<div class="line"><a class="code" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77" title="size of a container">Size</a> size();</div>
<div class="line"> </div>
<div class="line"><span class="comment">// modifiers</span></div>
<div class="line"><span class="keywordtype">void</span> setTime(<a class="code" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7" title="continuous quantity with 1-year units">Time</a> t);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// operator interface</span></div>
<div class="line">array_type applyTo(<span class="keyword">const</span> array_type&);</div>
<div class="line"><span class="keyword">static</span> Operator identity(<a class="code" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77" title="size of a container">Size</a> size);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// operator algebra</span></div>
<div class="line">Operator operator*(<a class="code" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78" title="real number">Real</a>, <span class="keyword">const</span> Operator&);</div>
<div class="line">Operator operator-(<span class="keyword">const</span> Operator&, <span class="keyword">const</span> Operator&);</div>
</div><!-- fragment --></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>
|
