File: class_quant_lib_1_1_mc_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 (120 lines) | stat: -rw-r--r-- 8,538 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
<!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: McPricer 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_mc_pricer.html">McPricer</a></div>
<h1>McPricer Class Template Reference</h1><!-- doxytag: class="QuantLib::McPricer" --><code>#include &lt;ql/legacy/pricers/mcpricer.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for McPricer:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_mc_pricer__inherit__graph.png" border="0" usemap="#_mc_pricer__inherit__map" alt="Inheritance graph"></center>
<map name="_mc_pricer__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_mc_cliquet_option.html" title="simple example of Monte Carlo pricer" alt="" coords="161,5,756,32"><area shape="rect" href="class_quant_lib_1_1_mc_discrete_arithmetic_a_s_o.html" title="Discrete arithmetic average&#45;strike Asian option." alt="" coords="131,56,787,83"><area shape="rect" href="class_quant_lib_1_1_mc_everest.html" title="Everest&#45;type option pricer." alt="" coords="184,107,733,133"><area shape="rect" href="class_quant_lib_1_1_mc_himalaya.html" title="Himalayan&#45;type option pricer." alt="" coords="179,157,739,184"><area shape="rect" href="class_quant_lib_1_1_mc_pagoda.html" title="roofed Asian option" alt="" coords="185,208,732,235"><area shape="rect" href="class_quant_lib_1_1_mc_performance_option.html" title="Performance option computed using Monte Carlo simulation." alt="" coords="141,259,776,285"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_mc_pricer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;template&lt; class &gt; class MC, class RNG, class S = Statistics&gt;<br>
 class QuantLib::McPricer&lt; MC, RNG, S &gt;</h3>

base class for Monte Carlo pricers 
<p>
Eventually this class might be linked to the general tree of pricers, in order to have tools like impliedVolatility available. Also, it could, eventually, offer greeks methods. Deriving a class from <a class="el" href="class_quant_lib_1_1_mc_pricer.html" title="base class for Monte Carlo pricers">McPricer</a> gives an easy way to write a Monte Carlo Pricer. See McEuropean as example of one factor pricer, Basket as example of multi factor pricer. <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="0131b7aa95623a2f0c9b9e241ae7abfd"></a><!-- doxytag: member="QuantLib::McPricer::value" ref="0131b7aa95623a2f0c9b9e241ae7abfd" args="(Real tolerance, Size maxSamples=QL_MAX_INTEGER, Size minSamples=1023) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#0131b7aa95623a2f0c9b9e241ae7abfd">value</a> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> tolerance, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> maxSamples=QL_MAX_INTEGER, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> minSamples=1023) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add samples until the required tolerance is reached <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee2ce0de3d492135899f008068926a65"></a><!-- doxytag: member="QuantLib::McPricer::valueWithSamples" ref="ee2ce0de3d492135899f008068926a65" args="(Size samples, Size minSamples=1023) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#ee2ce0de3d492135899f008068926a65">valueWithSamples</a> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> samples, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> minSamples=1023) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">simulate a fixed number of samples <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc5ad105e834e2360818b4f5046bd1f5"></a><!-- doxytag: member="QuantLib::McPricer::errorEstimate" ref="cc5ad105e834e2360818b4f5046bd1f5" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#cc5ad105e834e2360818b4f5046bd1f5">errorEstimate</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">estimated error of the samples simulated so far <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="959f290b6f98a265ff834b92c9b20588"></a><!-- doxytag: member="QuantLib::McPricer::sampleAccumulator" ref="959f290b6f98a265ff834b92c9b20588" args="(void) const " -->
const S &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#959f290b6f98a265ff834b92c9b20588">sampleAccumulator</a> (void) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access to the sample accumulator for more statistics <br></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="578bfc5052dad419af0dafb920aff02d"></a><!-- doxytag: member="QuantLib::McPricer::mcModel_" ref="578bfc5052dad419af0dafb920aff02d" args="" -->
boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_monte_carlo_model.html">MonteCarloModel</a>&lt; MC, RNG, S &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>mcModel_</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>