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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<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.3.14</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="faq.html">Frequently asked questions</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="todo.html">Todo List</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<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 <ql/Pricers/mcpricer.hpp></code>
<p>
Inheritance diagram for McPricer:<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 href="class_quant_lib_1_1_mc_cliquet_option.html" shape="rect" coords="164,5,1300,29" alt="">
<area href="class_quant_lib_1_1_mc_discrete_arithmetic_a_s_o.html" shape="rect" coords="133,53,1331,77" alt="">
<area href="class_quant_lib_1_1_mc_everest.html" shape="rect" coords="189,101,1275,125" alt="">
<area href="class_quant_lib_1_1_mc_himalaya.html" shape="rect" coords="183,149,1281,173" alt="">
<area href="class_quant_lib_1_1_mc_max_basket.html" shape="rect" coords="179,197,1285,221" alt="">
<area href="class_quant_lib_1_1_mc_pagoda.html" shape="rect" coords="191,245,1273,269" alt="">
<area href="class_quant_lib_1_1_mc_performance_option.html" shape="rect" coords="145,293,1319,317" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><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<class MC, class S = Statistics><br>
class QuantLib::McPricer< MC, S ></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">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.
<p>
<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="efb644d627928b43e12d6fb530249594"></a><!-- doxytag: member="QuantLib::McPricer::value" ref="efb644d627928b43e12d6fb530249594" args="(Real tolerance, Size maxSamples=QL_MAX_INTEGER, Size minSamples=1023) const" -->
Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#efb644d627928b43e12d6fb530249594">value</a> (Real tolerance, Size maxSamples=QL_MAX_INTEGER, Size minSamples=1023) const</td></tr>
<tr><td class="mdescLeft"> </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="bf34f41e98a4ddd68ab16551017ba116"></a><!-- doxytag: member="QuantLib::McPricer::valueWithSamples" ref="bf34f41e98a4ddd68ab16551017ba116" args="(Size samples, Size minSamples=1023) const" -->
Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#bf34f41e98a4ddd68ab16551017ba116">valueWithSamples</a> (Size samples, Size minSamples=1023) const</td></tr>
<tr><td class="mdescLeft"> </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="7f7b2ee66cf1eca0aecb6f1e65549798"></a><!-- doxytag: member="QuantLib::McPricer::errorEstimate" ref="7f7b2ee66cf1eca0aecb6f1e65549798" args="() const" -->
Real </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#7f7b2ee66cf1eca0aecb6f1e65549798">errorEstimate</a> () const</td></tr>
<tr><td class="mdescLeft"> </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="02c2551e9932b771a49f7bee3d0b645d"></a><!-- doxytag: member="QuantLib::McPricer::sampleAccumulator" ref="02c2551e9932b771a49f7bee3d0b645d" args="(void) const" -->
const S & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_mc_pricer.html#02c2551e9932b771a49f7bee3d0b645d">sampleAccumulator</a> (void) const</td></tr>
<tr><td class="mdescLeft"> </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="3f111449f62c45083e2b87563f70a4a2"></a><!-- doxytag: member="QuantLib::McPricer::mcModel_" ref="3f111449f62c45083e2b87563f70a4a2" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_monte_carlo_model.html">MonteCarloModel</a><<br>
MC, S > > </td><td class="memItemRight" valign="bottom"><b>mcModel_</b></td></tr>
</table>
</div>
<div class="footer">
<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
|