File: class_quant_lib_1_1_f_d_vanilla_engine.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (177 lines) | stat: -rw-r--r-- 14,618 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
176
177
<!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: FDVanillaEngine 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="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_f_d_vanilla_engine.html">FDVanillaEngine</a></div>
<h1>FDVanillaEngine Class Reference<br>
<small>
[<a class="el" href="group__vanillaengines.html">Vanilla option engines</a>]</small>
</h1><!-- doxytag: class="QuantLib::FDVanillaEngine" --><code>#include &lt;ql/pricingengines/vanilla/fdvanillaengine.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for FDVanillaEngine:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_f_d_vanilla_engine__inherit__graph.png" border="0" usemap="#_f_d_vanilla_engine__inherit__map" alt="Inheritance graph"></center>
<map name="_f_d_vanilla_engine__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_f_d_european_engine.html" title="Pricing engine for European options using finite&#45;differences." alt="" coords="5,84,152,111"><area shape="rect" href="class_quant_lib_1_1_f_d_step_condition_engine.html" title="Finite&#45;differences pricing engine for American&#45;style vanilla options." alt="" coords="176,84,352,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_f_d_vanilla_engine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Finite-differences pricing engine for BSM one asset options. 
<p>
The name is a misnomer as this is a base class for any finite difference scheme. Its main job is to handle grid layout. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="9f23f63944cfbb2f8f87765ca0e78e14"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::FDVanillaEngine" ref="9f23f63944cfbb2f8f87765ca0e78e14" args="(const boost::shared_ptr&lt; GeneralizedBlackScholesProcess &gt; &amp;process, Size timeSteps, Size gridPoints, bool timeDependent=false)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FDVanillaEngine</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> &gt; &amp;process, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> timeSteps, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> gridPoints, bool timeDependent=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16c466291f64905ece2498448e304db1"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::grid" ref="16c466291f64905ece2498448e304db1" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>grid</b> () const </td></tr>

<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="654b2d0f68b7cc7daa7dc3d3b19ddb87"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::bc_type" ref="654b2d0f68b7cc7daa7dc3d3b19ddb87" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_boundary_condition.html">BoundaryCondition</a><br>
&lt; <a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html">TridiagonalOperator</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bc_type</b></td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="962e8e99edd2b2802cb56cb06c572ec2"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::setupArguments" ref="962e8e99edd2b2802cb56cb06c572ec2" args="(const PricingEngine::arguments *) const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setupArguments</b> (const PricingEngine::arguments *) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab2fa1494d4f4992fbfdbbc6df8328fc"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::setGridLimits" ref="ab2fa1494d4f4992fbfdbbc6df8328fc" args="() const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setGridLimits</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95a121986a34191e5e0e79614f1291bc"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::setGridLimits" ref="95a121986a34191e5e0e79614f1291bc" args="(Real, Time) const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setGridLimits</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78e07ab8f1efe95af3620d4515bee51d"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::initializeInitialCondition" ref="78e07ab8f1efe95af3620d4515bee51d" args="() const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>initializeInitialCondition</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec873e3e9f589c5f7450e44c176bba53"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::initializeBoundaryConditions" ref="ec873e3e9f589c5f7450e44c176bba53" args="() const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>initializeBoundaryConditions</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11960243546eb3fbfd156bb356521f0c"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::initializeOperator" ref="11960243546eb3fbfd156bb356521f0c" args="() const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>initializeOperator</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="674e7ea5e90acab0262d251898ff792d"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::getResidualTime" ref="674e7ea5e90acab0262d251898ff792d" args="() const " -->
virtual <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>getResidualTime</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1dd3d1c5ca170640a5924b2ee281e41"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::ensureStrikeInGrid" ref="e1dd3d1c5ca170640a5924b2ee281e41" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ensureStrikeInGrid</b> () const </td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56894d395192aaae9970e5f03c5ad02f"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::process_" ref="56894d395192aaae9970e5f03c5ad02f" args="" -->
boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>process_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02b035f6fcde4fb3cc9964c0518964ae"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::timeSteps_" ref="02b035f6fcde4fb3cc9964c0518964ae" args="" -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>timeSteps_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7145182f52df597ca8aa4d5866217c1e"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::gridPoints_" ref="7145182f52df597ca8aa4d5866217c1e" args="" -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>gridPoints_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe877f42f51da049474a29ca152f6e38"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::timeDependent_" ref="fe877f42f51da049474a29ca152f6e38" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>timeDependent_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a97f4313a9da6e57d378b06ffcb41a1"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::requiredGridValue_" ref="5a97f4313a9da6e57d378b06ffcb41a1" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>requiredGridValue_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82043c5ad79ac1b7b969001c0fac6b01"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::exerciseDate_" ref="82043c5ad79ac1b7b969001c0fac6b01" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>exerciseDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73cfad8707a6a802108b5bb7e04aca75"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::payoff_" ref="73cfad8707a6a802108b5bb7e04aca75" args="" -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_payoff.html">Payoff</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>payoff_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="339a08d2d842659617830840971da35e"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::finiteDifferenceOperator_" ref="339a08d2d842659617830840971da35e" args="" -->
<a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html">TridiagonalOperator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>finiteDifferenceOperator_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8edf65769664d4ebdccdf4570511510f"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::intrinsicValues_" ref="8edf65769664d4ebdccdf4570511510f" args="" -->
<a class="el" href="class_quant_lib_1_1_sampled_curve.html">SampledCurve</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>intrinsicValues_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5ad104496c57fc44c7d043228540df3"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::BCs_" ref="f5ad104496c57fc44c7d043228540df3" args="" -->
std::vector&lt; boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_boundary_condition.html">bc_type</a> &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>BCs_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8993bc76e2e718431695d0ad5844f76"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::sMin_" ref="d8993bc76e2e718431695d0ad5844f76" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>sMin_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d1498fa8ea69ec53974976d2de35a8e"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::center_" ref="6d1498fa8ea69ec53974976d2de35a8e" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>center_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3e79b584dea15108e9e47722b105e03"></a><!-- doxytag: member="QuantLib::FDVanillaEngine::sMax_" ref="a3e79b584dea15108e9e47722b105e03" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>sMax_</b></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>