File: class_quant_lib_1_1_longstaff_schwartz_path_pricer.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 (143 lines) | stat: -rw-r--r-- 9,340 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
<!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: LongstaffSchwartzPathPricer 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_longstaff_schwartz_path_pricer.html">LongstaffSchwartzPathPricer</a></div>
<h1>LongstaffSchwartzPathPricer Class Template Reference<br>
<small>
[<a class="el" href="group__mcarlo.html">Monte Carlo framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::LongstaffSchwartzPathPricer" --><!-- doxytag: inherits="QuantLib::PathPricer&lt; PathType &gt;" --><code>#include &lt;ql/methods/montecarlo/longstaffschwartzpathpricer.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for LongstaffSchwartzPathPricer:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_longstaff_schwartz_path_pricer__inherit__graph.png" border="0" usemap="#_longstaff_schwartz_path_pricer__inherit__map" alt="Inheritance graph"></center>
<map name="_longstaff_schwartz_path_pricer__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_path_pricer.html" title="PathPricer\&lt; PathType \&gt;" alt="" coords="23,7,199,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_longstaff_schwartz_path_pricer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class PathType&gt;<br>
 class QuantLib::LongstaffSchwartzPathPricer&lt; PathType &gt;</h3>

Longstaff-Schwarz path pricer 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#_test000068">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="8f1d307035ca52ae82e4c13aa0cfe635"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::StateType" ref="8f1d307035ca52ae82e4c13aa0cfe635" args="" -->
typedef EarlyExerciseTraits<br>
&lt; PathType &gt;::StateType&nbsp;</td><td class="memItemRight" valign="bottom"><b>StateType</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="916ae89df9f44e1ffcc92c261a602c5d"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::LongstaffSchwartzPathPricer" ref="916ae89df9f44e1ffcc92c261a602c5d" args="(const TimeGrid &amp;times, const boost::shared_ptr&lt; EarlyExercisePathPricer&lt; PathType &gt; &gt; &amp;, const boost::shared_ptr&lt; YieldTermStructure &gt; &amp;termStructure)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>LongstaffSchwartzPathPricer</b> (const <a class="el" href="class_quant_lib_1_1_time_grid.html">TimeGrid</a> &amp;times, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_early_exercise_path_pricer.html">EarlyExercisePathPricer</a>&lt; PathType &gt; &gt; &amp;, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;termStructure)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="973b5f4a40082fdcd2ccbb91e5116756"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::operator()" ref="973b5f4a40082fdcd2ccbb91e5116756" args="(const PathType &amp;path) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (const PathType &amp;path) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4a7316a51b17d0f691bb3e33b95a5ad"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::calibrate" ref="d4a7316a51b17d0f691bb3e33b95a5ad" args="()" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>calibrate</b> ()</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="2bf0af9827386f85f987316431e81711"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::calibrationPhase_" ref="2bf0af9827386f85f987316431e81711" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>calibrationPhase_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae6fc85412d430df60e5a9a6f75adb0b"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::pathPricer_" ref="ae6fc85412d430df60e5a9a6f75adb0b" args="" -->
const boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_early_exercise_path_pricer.html">EarlyExercisePathPricer</a><br>
&lt; PathType &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>pathPricer_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="41a0f0d111413d6b14e5ee6c0b49bc04"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::coeff_" ref="41a0f0d111413d6b14e5ee6c0b49bc04" args="" -->
boost::scoped_array&lt; <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>coeff_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5da556975f74f50a2e9efc043e616f0"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::dF_" ref="a5da556975f74f50a2e9efc043e616f0" args="" -->
boost::scoped_array<br>
&lt; <a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>dF_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="725caf1043d9257b4fe46ff5bfce78f4"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::paths_" ref="725caf1043d9257b4fe46ff5bfce78f4" args="" -->
std::vector&lt; PathType &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>paths_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9fc199a3fca80adc28ac11ca88e71a82"></a><!-- doxytag: member="QuantLib::LongstaffSchwartzPathPricer::v_" ref="9fc199a3fca80adc28ac11ca88e71a82" args="" -->
const std::vector<br>
&lt; boost::function1&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>,<br>
 StateType &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>v_</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>