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
|
<!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: MCLongstaffSchwartzEngine 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_m_c_longstaff_schwartz_engine.html">MCLongstaffSchwartzEngine</a></div>
<h1>MCLongstaffSchwartzEngine Class Template Reference</h1><!-- doxytag: class="QuantLib::MCLongstaffSchwartzEngine" --><!-- doxytag: inherits="QuantLib::GenericEngine,QuantLib::McSimulation" --><code>#include <ql/pricingengines/mclongstaffschwartzengine.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for MCLongstaffSchwartzEngine:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_m_c_longstaff_schwartz_engine__inherit__graph.png" border="0" usemap="#_m_c_longstaff_schwartz_engine__inherit__map" alt="Inheritance graph"></center>
<map name="_m_c_longstaff_schwartz_engine__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_m_c_american_basket_engine.html" title="least-square Monte Carlo engine" alt="" coords="529,5,1204,32"><area shape="rect" href="class_quant_lib_1_1_m_c_american_engine.html" title="American Monte Carlo engine." alt="" coords="573,56,1160,83"><area shape="rect" href="class_quant_lib_1_1_generic_engine.html" title="template base class for option pricing engines" alt="" coords="56,5,171,32"><area shape="rect" href="class_quant_lib_1_1_mc_simulation.html" title="base class for Monte Carlo engines" alt="" coords="5,56,221,83"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_m_c_longstaff_schwartz_engine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class GenericEngine, template< class > class MC, class RNG, class S = Statistics><br>
class QuantLib::MCLongstaffSchwartzEngine< GenericEngine, MC, RNG, S ></h3>
Longstaff-Schwarz Monte Carlo engine for early exercise options.
<p>
References:<p>
Francis Longstaff, Eduardo Schwartz, 2001. Valuing American Options by Simulation: A Simple Least-Squares Approach, The Review of Financial Studies, Volume 14, No. 1, 113-147<p>
<dl compact><dt><b><a class="el" href="test.html#_test000091">Tests:</a></b></dt><dd>the correctness of the returned value is tested by reproducing results available in web/literature </dd></dl>
<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="448f662b148297f7628d0db98064f1c2"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::path_type" ref="448f662b148297f7628d0db98064f1c2" args="" -->
typedef MC< RNG >::path_type </td><td class="memItemRight" valign="bottom"><b>path_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e8c6745d46fec52af674b05ce5b75d7"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::stats_type" ref="9e8c6745d46fec52af674b05ce5b75d7" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_mc_simulation.html">McSimulation</a>< MC, RNG,<br>
S >::stats_type </td><td class="memItemRight" valign="bottom"><b>stats_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7922dd7fea2c004ef3dc817d274cfe84"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::path_pricer_type" ref="7922dd7fea2c004ef3dc817d274cfe84" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_mc_simulation.html">McSimulation</a>< MC, RNG,<br>
S >::path_pricer_type </td><td class="memItemRight" valign="bottom"><b>path_pricer_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e301ff1e9761ffd43e2e8a626d5ae90"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::path_generator_type" ref="2e301ff1e9761ffd43e2e8a626d5ae90" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_mc_simulation.html">McSimulation</a>< MC, RNG,<br>
S >::path_generator_type </td><td class="memItemRight" valign="bottom"><b>path_generator_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="894a2d7f9478542e490dafd0efb8090b"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::MCLongstaffSchwartzEngine" ref="894a2d7f9478542e490dafd0efb8090b" args="(const boost::shared_ptr< StochasticProcess > &process, Size timeSteps, Size timeStepsPerYear, bool brownianBridge, bool antitheticVariate, bool controlVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed, Size nCalibrationSamples=Null< Size >())" -->
</td><td class="memItemRight" valign="bottom"><b>MCLongstaffSchwartzEngine</b> (const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_stochastic_process.html">StochasticProcess</a> > &process, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> timeSteps, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> timeStepsPerYear, bool brownianBridge, bool antitheticVariate, bool controlVariate, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> requiredSamples, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> requiredTolerance, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> maxSamples, <a class="el" href="namespace_quant_lib.html#e3df3f13e67885465f4e359b3bffa4e6">BigNatural</a> seed, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> nCalibrationSamples=<a class="el" href="class_quant_lib_1_1_null.html">Null</a>< <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> >())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10873979f635888606e03f9cb2d8a096"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::calculate" ref="10873979f635888606e03f9cb2d8a096" args="() const " -->
void </td><td class="memItemRight" valign="bottom"><b>calculate</b> () const </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="87c8e8f4035bffb8f0426e3ab7778713"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::lsmPathPricer" ref="87c8e8f4035bffb8f0426e3ab7778713" args="() const =0" -->
virtual boost::shared_ptr<br>
< <a class="el" href="class_quant_lib_1_1_longstaff_schwartz_path_pricer.html">LongstaffSchwartzPathPricer</a><br>
< path_type > > </td><td class="memItemRight" valign="bottom"><b>lsmPathPricer</b> () const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac0bc663d50bdc0fd6771bb1ad2481e5"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::timeGrid" ref="ac0bc663d50bdc0fd6771bb1ad2481e5" args="() const " -->
<a class="el" href="class_quant_lib_1_1_time_grid.html">TimeGrid</a> </td><td class="memItemRight" valign="bottom"><b>timeGrid</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78b83c9144dd5411fbf5b70280bfdf4e"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::pathPricer" ref="78b83c9144dd5411fbf5b70280bfdf4e" args="() const " -->
boost::shared_ptr<br>
< path_pricer_type > </td><td class="memItemRight" valign="bottom"><b>pathPricer</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bad9146c6aadae919174e51ab0b6533e"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::pathGenerator" ref="bad9146c6aadae919174e51ab0b6533e" args="() const " -->
boost::shared_ptr<br>
< path_generator_type > </td><td class="memItemRight" valign="bottom"><b>pathGenerator</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="a94312a20d5fdd30808a9c44fea1c986"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::process_" ref="a94312a20d5fdd30808a9c44fea1c986" args="" -->
boost::shared_ptr<br>
< <a class="el" href="class_quant_lib_1_1_stochastic_process.html">StochasticProcess</a> > </td><td class="memItemRight" valign="bottom"><b>process_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a8040241758f53937896005a5764344"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::timeSteps_" ref="1a8040241758f53937896005a5764344" args="" -->
const <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>timeSteps_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d58dc5329a35fa64347940b5f1221fab"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::timeStepsPerYear_" ref="d58dc5329a35fa64347940b5f1221fab" args="" -->
const <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>timeStepsPerYear_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51081fa144e357770bd49b179b58935c"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::brownianBridge_" ref="51081fa144e357770bd49b179b58935c" args="" -->
const bool </td><td class="memItemRight" valign="bottom"><b>brownianBridge_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a4398e3334d904c7a7e02133d6cf0e6"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::requiredSamples_" ref="7a4398e3334d904c7a7e02133d6cf0e6" args="" -->
const <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>requiredSamples_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23b4d398d041075802696987e2245fce"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::requiredTolerance_" ref="23b4d398d041075802696987e2245fce" args="" -->
const <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>requiredTolerance_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c44a253fd9a36577d257d179e236061b"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::maxSamples_" ref="c44a253fd9a36577d257d179e236061b" args="" -->
const <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>maxSamples_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b3f7693fb03f7e4a6950437590d497a"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::seed_" ref="4b3f7693fb03f7e4a6950437590d497a" args="" -->
const <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>seed_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2c329ea8ac927646ea5562bdc6981c6"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::nCalibrationSamples_" ref="a2c329ea8ac927646ea5562bdc6981c6" args="" -->
const <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>nCalibrationSamples_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f3ea19d392c85d2d3937d4ac59a0868c"></a><!-- doxytag: member="QuantLib::MCLongstaffSchwartzEngine::pathPricer_" ref="f3ea19d392c85d2d3937d4ac59a0868c" args="" -->
boost::shared_ptr<br>
< <a class="el" href="class_quant_lib_1_1_longstaff_schwartz_path_pricer.html">LongstaffSchwartzPathPricer</a><br>
< path_type > > </td><td class="memItemRight" valign="bottom"><b>pathPricer_</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>
|
