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>QuantLib: ImplicitEuler 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.9.0</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="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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_implicit_euler.html">ImplicitEuler</a></div>
<h1>ImplicitEuler Class Template Reference<br>
<small>
[<a class="el" href="group__findiff.html">Finite-differences framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::ImplicitEuler" --><!-- doxytag: inherits="QuantLib::MixedScheme" --><code>#include <ql/methods/finitedifferences/impliciteuler.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for ImplicitEuler:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_implicit_euler__inherit__graph.png" border="0" usemap="#_implicit_euler__inherit__map" alt="Inheritance graph"></center>
<map name="_implicit_euler__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_mixed_scheme.html" title="Mixed (explicit/implicit) scheme for finite difference methods." alt="" coords="5,7,205,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_implicit_euler-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class Operator><br>
class QuantLib::ImplicitEuler< Operator ></h3>
Backward Euler scheme for finite difference methods.
<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&);
Operator& operator=(<span class="keyword">const</span> Operator&);
<span class="comment">// inspectors</span>
<a class="code" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77" title="size of a container">Size</a> size();
<span class="comment">// modifiers</span>
<span class="keywordtype">void</span> setTime(<a class="code" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7" title="continuous quantity with 1-year units">Time</a> t);
<span class="comment">// operator interface</span>
array_type solveFor(<span class="keyword">const</span> array_type&);
<span class="keyword">static</span> Operator identity(<a class="code" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77" title="size of a container">Size</a> size);
<span class="comment">// operator algebra</span>
Operator operator*(<a class="code" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78" title="real number">Real</a>, <span class="keyword">const</span> Operator&);
Operator operator+(<span class="keyword">const</span> Operator&, <span class="keyword">const</span> Operator&);
</pre></div> <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::ImplicitEuler::traits" ref="b85b62c5cc90bded0075d322e91fd993" args="" -->
typedef OperatorTraits< Operator > </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::ImplicitEuler::operator_type" ref="02ede700df8d04acf392294f6ab090c4" args="" -->
typedef traits::operator_type </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::ImplicitEuler::array_type" ref="c07e755f1412353806d561469c9ad49f" args="" -->
typedef traits::array_type </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="7fb68e182d263712988c9b0afe1ad6a0"></a><!-- doxytag: member="QuantLib::ImplicitEuler::bc_set" ref="7fb68e182d263712988c9b0afe1ad6a0" args="" -->
typedef traits::bc_set </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::ImplicitEuler::condition_type" ref="9b68be7f0b8097f723468a930f604c39" args="" -->
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><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d3488329720367c427f836b019924cf"></a><!-- doxytag: member="QuantLib::ImplicitEuler::ImplicitEuler" ref="9d3488329720367c427f836b019924cf" args="(const operator_type &L, const bc_set &bcs)" -->
</td><td class="memItemRight" valign="bottom"><b>ImplicitEuler</b> (const operator_type &L, const bc_set &bcs)</td></tr>
</table>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|