File: class_quant_lib_1_1_make_m_c_american_engine.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (134 lines) | stat: -rw-r--r-- 10,581 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
<!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>MakeMCAmericanEngine&lt; RNG, S &gt; 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="185" height="50" 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 1.2</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="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="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="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">MakeMCAmericanEngine&lt; RNG, S &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::MakeMCAmericanEngine" -->
<p>Monte Carlo American engine factory.  
 <a href="class_quant_lib_1_1_make_m_c_american_engine.html#details">More...</a></p>

<p><code>#include &lt;ql/pricingengines/vanilla/mcamericanengine.hpp&gt;</code></p>

<p><a href="class_quant_lib_1_1_make_m_c_american_engine-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c7a80957c80444f6f0486cf13c2f5a1"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::MakeMCAmericanEngine" ref="a5c7a80957c80444f6f0486cf13c2f5a1" args="(const boost::shared_ptr&lt; GeneralizedBlackScholesProcess &gt; &amp;)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>MakeMCAmericanEngine</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> &gt; &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e2014ef955181953e7cee89a8bc45b8"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withSteps" ref="a1e2014ef955181953e7cee89a8bc45b8" args="(Size steps)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withSteps</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> steps)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6173cdad29cb3457267df9c4e9765bfa"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withStepsPerYear" ref="a6173cdad29cb3457267df9c4e9765bfa" args="(Size steps)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withStepsPerYear</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> steps)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22eb14626e60b0100c56f06c3962ae82"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withSamples" ref="a22eb14626e60b0100c56f06c3962ae82" args="(Size samples)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withSamples</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> samples)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6cd895b87605c2e2c2abd1595c2d94e"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withAbsoluteTolerance" ref="ac6cd895b87605c2e2c2abd1595c2d94e" args="(Real tolerance)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withAbsoluteTolerance</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> tolerance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb1a2381e08ae45cb0b8fe92eec53482"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withMaxSamples" ref="acb1a2381e08ae45cb0b8fe92eec53482" args="(Size samples)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withMaxSamples</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> samples)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5189c6e021ad3b7b9def772f3387512d"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withSeed" ref="a5189c6e021ad3b7b9def772f3387512d" args="(BigNatural seed)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withSeed</b> (BigNatural seed)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8635128ef9a58a27fb2e766facfc5ceb"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withAntitheticVariate" ref="a8635128ef9a58a27fb2e766facfc5ceb" args="(bool b=true)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withAntitheticVariate</b> (bool b=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac52db43cccebc8db7feda06184e1d158"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withControlVariate" ref="ac52db43cccebc8db7feda06184e1d158" args="(bool b=true)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withControlVariate</b> (bool b=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad31e3487ee6cf17bdb33452b92462364"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withPolynomOrder" ref="ad31e3487ee6cf17bdb33452b92462364" args="(Size polynomOrer)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withPolynomOrder</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> polynomOrer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f791c58ab6c1f807affdd8645543e57"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withBasisSystem" ref="a4f791c58ab6c1f807affdd8645543e57" args="(LsmBasisSystem::PolynomType)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withBasisSystem</b> (LsmBasisSystem::PolynomType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79fd7d285b4900128879823c52e68e2c"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::withCalibrationSamples" ref="a79fd7d285b4900128879823c52e68e2c" args="(Size calibrationSamples)" -->
<a class="el" href="class_quant_lib_1_1_make_m_c_american_engine.html">MakeMCAmericanEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>withCalibrationSamples</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> calibrationSamples)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fba5728f2e7e979edc8fce741709a97"></a><!-- doxytag: member="QuantLib::MakeMCAmericanEngine::operator boost::shared_ptr&lt; PricingEngine &gt;" ref="a9fba5728f2e7e979edc8fce741709a97" args="() const " -->
&#160;</td><td class="memItemRight" valign="bottom"><b>operator boost::shared_ptr&lt; PricingEngine &gt;</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class RNG = PseudoRandom, class S = Statistics&gt;<br/>
class QuantLib::MakeMCAmericanEngine&lt; RNG, S &gt;</h3>

<p>Monte Carlo American engine factory. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_equity_option_8cpp-example.html#_a44">EquityOption.cpp</a>.</dd>
</dl></div></div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>