File: class_quant_lib_1_1_modified_craig_sneyd_scheme.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 (141 lines) | stat: -rw-r--r-- 9,871 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
<!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>ModifiedCraigSneydScheme Class 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_modified_craig_sneyd_scheme.html">ModifiedCraigSneydScheme</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-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ModifiedCraigSneydScheme Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ModifiedCraigSneydScheme" -->
<p>modified Craig-Sneyd scheme  
 <a href="class_quant_lib_1_1_modified_craig_sneyd_scheme.html#details">More...</a></p>

<p><code>#include &lt;ql/methods/finitedifferences/schemes/modifiedcraigsneydscheme.hpp&gt;</code></p>

<p><a href="class_quant_lib_1_1_modified_craig_sneyd_scheme-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"><a class="anchor" id="ad66caa3a712f1851c280155e836560f1"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::traits" ref="ad66caa3a712f1851c280155e836560f1" args="" -->
typedef OperatorTraits<br class="typebreak"/>
&lt; FdmLinearOp &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>traits</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02ede700df8d04acf392294f6ab090c4"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::operator_type" ref="a02ede700df8d04acf392294f6ab090c4" args="" -->
typedef traits::operator_type&#160;</td><td class="memItemRight" valign="bottom"><b>operator_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac07e755f1412353806d561469c9ad49f"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::array_type" ref="ac07e755f1412353806d561469c9ad49f" args="" -->
typedef traits::array_type&#160;</td><td class="memItemRight" valign="bottom"><b>array_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fb68e182d263712988c9b0afe1ad6a0"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::bc_set" ref="a7fb68e182d263712988c9b0afe1ad6a0" args="" -->
typedef traits::bc_set&#160;</td><td class="memItemRight" valign="bottom"><b>bc_set</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b68be7f0b8097f723468a930f604c39"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::condition_type" ref="a9b68be7f0b8097f723468a930f604c39" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_step_condition.html">traits::condition_type</a>&#160;</td><td class="memItemRight" valign="bottom"><b>condition_type</b></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="a76a5f707741a083c6f4dbaaf3ee494f5"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::ModifiedCraigSneydScheme" ref="a76a5f707741a083c6f4dbaaf3ee494f5" args="(Real theta, Real mu, const boost::shared_ptr&lt; FdmLinearOpComposite &gt; &amp;map, const std::vector&lt; boost::shared_ptr&lt; FdmDirichletBoundary &gt; &gt; &amp;bc_set=std::vector&lt; boost::shared_ptr&lt; FdmDirichletBoundary &gt; &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ModifiedCraigSneydScheme</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> theta, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> mu, const boost::shared_ptr&lt; FdmLinearOpComposite &gt; &amp;map, const std::vector&lt; boost::shared_ptr&lt; FdmDirichletBoundary &gt; &gt; &amp;bc_set=std::vector&lt; boost::shared_ptr&lt; FdmDirichletBoundary &gt; &gt;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae31015dcf2ddc4f248be2533b0bbbd95"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::step" ref="ae31015dcf2ddc4f248be2533b0bbbd95" args="(array_type &amp;a, Time t)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>step</b> (array_type &amp;a, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c6bf7e1e335626aa6f4e7a46f361b50"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::setStep" ref="a7c6bf7e1e335626aa6f4e7a46f361b50" args="(Time dt)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setStep</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> dt)</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="a6be603d8547f31e72817d2aaf219e325"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::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="a290a7be767e7d6796da0962c2462d785"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::theta_" ref="a290a7be767e7d6796da0962c2462d785" args="" -->
const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>theta_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f72ee8e7b9ca115f61ebd6c7fa65251"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::mu_" ref="a4f72ee8e7b9ca115f61ebd6c7fa65251" args="" -->
const <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>mu_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af39714d9545afb8b657218e47c8d34fa"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::map_" ref="af39714d9545afb8b657218e47c8d34fa" args="" -->
const boost::shared_ptr<br class="typebreak"/>
&lt; FdmLinearOpComposite &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>map_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f13d4cdd0a54c11bd935450ba2e26e5"></a><!-- doxytag: member="QuantLib::ModifiedCraigSneydScheme::bcSet_" ref="a4f13d4cdd0a54c11bd935450ba2e26e5" args="" -->
const std::vector<br class="typebreak"/>
&lt; boost::shared_ptr<br class="typebreak"/>
&lt; FdmDirichletBoundary &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>bcSet_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>modified Craig-Sneyd scheme </p>
<p>References: K. J. in ’t Hout and S. Foulon, ADI finite difference schemes for option pricing in the Heston model with correlation, <a href="http://arxiv.org/pdf/0811.3427">http://arxiv.org/pdf/0811.3427</a> </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>