File: class_quant_lib_1_1_explicit_euler.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 (166 lines) | stat: -rw-r--r-- 9,311 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
<!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: ExplicitEuler 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_explicit_euler.html">ExplicitEuler</a></div>
<h1>ExplicitEuler Class Template Reference<br>
<small>
[<a class="el" href="group__findiff.html">Finite-differences framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::ExplicitEuler" --><!-- doxytag: inherits="QuantLib::MixedScheme" --><code>#include &lt;ql/FiniteDifferences/expliciteuler.hpp&gt;</code>
<p>
Inheritance diagram for ExplicitEuler:<p><center><img src="class_quant_lib_1_1_explicit_euler__inherit__graph.png" border="0" usemap="#_explicit_euler__inherit__map" alt="Inheritance graph"></center>
<map name="_explicit_euler__inherit__map">
<area href="class_quant_lib_1_1_mixed_scheme.html" shape="rect" coords="6,7,214,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_explicit_euler-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class Operator&gt;<br>
 class QuantLib::ExplicitEuler&lt; Operator &gt;</h3>

<a class="el" href="class_quant_lib_1_1_forward.html">Forward</a> Euler scheme for finite difference methods. 
<p>
See sect. <a class="el" href="group__findiff.html">Finite-differences framework</a> for details on the method.<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"><pre class="fragment">        <span class="keyword">typedef</span> ... array_type;

        <span class="comment">// copy constructor/assignment</span>
        <span class="comment">// (these will be provided by the compiler if none is defined)</span>
        Operator(<span class="keyword">const</span> Operator&amp;);
        Operator&amp; operator=(<span class="keyword">const</span> Operator&amp;);

        <span class="comment">// inspectors</span>
        <a class="code" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> size();

        <span class="comment">// modifiers</span>
        <span class="keywordtype">void</span> setTime(<a class="code" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t);

        <span class="comment">// operator interface</span>
        array_type applyTo(<span class="keyword">const</span> array_type&amp;);
        <span class="keyword">static</span> Operator identity(<a class="code" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> size);

        <span class="comment">// operator algebra</span>
        Operator operator*(<a class="code" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>, <span class="keyword">const</span> Operator&amp;);
        Operator operator-(<span class="keyword">const</span> Operator&amp;, <span class="keyword">const</span> Operator&amp;);
</pre></div><p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000012">Todo:</a></b></dt><dd>add Richardson extrapolation</dd></dl>

<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b85b62c5cc90bded0075d322e91fd993"></a><!-- doxytag: member="QuantLib::ExplicitEuler::traits" ref="b85b62c5cc90bded0075d322e91fd993" args="" -->
typedef OperatorTraits&lt; Operator &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>traits</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02ede700df8d04acf392294f6ab090c4"></a><!-- doxytag: member="QuantLib::ExplicitEuler::operator_type" ref="02ede700df8d04acf392294f6ab090c4" args="" -->
typedef traits::operator_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c07e755f1412353806d561469c9ad49f"></a><!-- doxytag: member="QuantLib::ExplicitEuler::array_type" ref="c07e755f1412353806d561469c9ad49f" args="" -->
typedef traits::array_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ef2ff2e57a5eb84f1e124859bac8d74"></a><!-- doxytag: member="QuantLib::ExplicitEuler::bc_type" ref="5ef2ff2e57a5eb84f1e124859bac8d74" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_boundary_condition.html">traits::bc_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>bc_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb68e182d263712988c9b0afe1ad6a0"></a><!-- doxytag: member="QuantLib::ExplicitEuler::bc_set" ref="7fb68e182d263712988c9b0afe1ad6a0" args="" -->
typedef traits::bc_set&nbsp;</td><td class="memItemRight" valign="bottom"><b>bc_set</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b68be7f0b8097f723468a930f604c39"></a><!-- doxytag: member="QuantLib::ExplicitEuler::condition_type" ref="9b68be7f0b8097f723468a930f604c39" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_step_condition.html">traits::condition_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>condition_type</b></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="e8554f66409add3f74084a628d27424b"></a><!-- doxytag: member="QuantLib::ExplicitEuler::ExplicitEuler" ref="e8554f66409add3f74084a628d27424b" args="(const operator_type &amp;L, const std::vector&lt; boost::shared_ptr&lt; bc_type &gt; &gt; &amp;bcs)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>ExplicitEuler</b> (const operator_type &amp;L, const std::vector&lt; boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_boundary_condition.html">bc_type</a> &gt; &gt; &amp;bcs)</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>