File: class_quant_lib_1_1_m_c_basket_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 (160 lines) | stat: -rw-r--r-- 11,799 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
<!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: MCBasketEngine 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_basket_engine.html">MCBasketEngine</a></div>
<h1>MCBasketEngine Class Template Reference<br>
<small>
[<a class="el" href="group__basketengines.html">Basket option engines</a>]</small>
</h1><!-- doxytag: class="QuantLib::MCBasketEngine" --><!-- doxytag: inherits="QuantLib::BasketOption::engine,QuantLib::McSimulation" --><code>#include &lt;ql/pricingengines/basket/mcbasketengine.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for MCBasketEngine:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_m_c_basket_engine__inherit__graph.png" border="0" usemap="#_m_c_basket_engine__inherit__map" alt="Inheritance graph"></center>
<map name="_m_c_basket_engine__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_basket_option_1_1engine.html" title="Basket&#45;option engine base class" alt="" coords="5,7,69,33"><area shape="rect" href="class_quant_lib_1_1_mc_simulation.html" title="base class for Monte Carlo engines" alt="" coords="93,7,488,33"></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_basket_engine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class RNG = PseudoRandom, class S = Statistics&gt;<br>
 class QuantLib::MCBasketEngine&lt; RNG, S &gt;</h3>

Pricing engine for basket options using Monte Carlo simulation. 
<p>
<dl compact><dt><b><a class="el" href="test.html#_test000081">Tests:</a></b></dt><dd>the correctness of the returned value is tested by reproducing results available in 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="97d0a464c09dfbac519dd3c4ed297523"></a><!-- doxytag: member="QuantLib::MCBasketEngine::path_generator_type" ref="97d0a464c09dfbac519dd3c4ed297523" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_mc_simulation.html">McSimulation</a><br>
&lt; <a class="el" href="struct_quant_lib_1_1_multi_variate.html">MultiVariate</a>, RNG, S &gt;<br>
::path_generator_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>path_generator_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a9d35263b41b36b002797dde605d942"></a><!-- doxytag: member="QuantLib::MCBasketEngine::path_pricer_type" ref="6a9d35263b41b36b002797dde605d942" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_mc_simulation.html">McSimulation</a><br>
&lt; <a class="el" href="struct_quant_lib_1_1_multi_variate.html">MultiVariate</a>, RNG, S &gt;<br>
::path_pricer_type&nbsp;</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="931267be1997474da010eacc9e911b29"></a><!-- doxytag: member="QuantLib::MCBasketEngine::stats_type" ref="931267be1997474da010eacc9e911b29" args="" -->
typedef <a class="el" href="class_quant_lib_1_1_mc_simulation.html">McSimulation</a><br>
&lt; <a class="el" href="struct_quant_lib_1_1_multi_variate.html">MultiVariate</a>, RNG, S &gt;<br>
::stats_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>stats_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="c2c5aaacbc3429fe72032078af37b573"></a><!-- doxytag: member="QuantLib::MCBasketEngine::MCBasketEngine" ref="c2c5aaacbc3429fe72032078af37b573" args="(const boost::shared_ptr&lt; StochasticProcessArray &gt; &amp;, Size maxTimeStepsPerYear, bool brownianBridge, bool antitheticVariate, bool controlVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>MCBasketEngine</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process_array.html">StochasticProcessArray</a> &gt; &amp;, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> maxTimeStepsPerYear, 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)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10873979f635888606e03f9cb2d8a096"></a><!-- doxytag: member="QuantLib::MCBasketEngine::calculate" ref="10873979f635888606e03f9cb2d8a096" args="() const " -->
void&nbsp;</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="ac0bc663d50bdc0fd6771bb1ad2481e5"></a><!-- doxytag: member="QuantLib::MCBasketEngine::timeGrid" ref="ac0bc663d50bdc0fd6771bb1ad2481e5" args="() const " -->
<a class="el" href="class_quant_lib_1_1_time_grid.html">TimeGrid</a>&nbsp;</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="7751aec86337c68f4b4ee807247f5648"></a><!-- doxytag: member="QuantLib::MCBasketEngine::pathGenerator" ref="7751aec86337c68f4b4ee807247f5648" args="() const " -->
boost::shared_ptr<br>
&lt; path_generator_type &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>pathGenerator</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="390c1f1370c8c6a561c64b545d743784"></a><!-- doxytag: member="QuantLib::MCBasketEngine::pathPricer" ref="390c1f1370c8c6a561c64b545d743784" args="() const " -->
boost::shared_ptr<br>
&lt; path_pricer_type &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>pathPricer</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="44461bbe7cf3adc237d74f325e7f68e2"></a><!-- doxytag: member="QuantLib::MCBasketEngine::processes_" ref="44461bbe7cf3adc237d74f325e7f68e2" args="" -->
boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process_array.html">StochasticProcessArray</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>processes_</b></td></tr>

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

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

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

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

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

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="654936ea7a7e268c1d02b452e80c7fdb"></a><!-- doxytag: member="QuantLib::MCBasketEngine::seed_" ref="654936ea7a7e268c1d02b452e80c7fdb" args="" -->
<a class="el" href="namespace_quant_lib.html#e3df3f13e67885465f4e359b3bffa4e6">BigNatural</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>seed_</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>