File: class_quant_lib_1_1_generic_model_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 (109 lines) | stat: -rw-r--r-- 7,241 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
<!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: GenericModelEngine 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_generic_model_engine.html">GenericModelEngine</a></div>
<h1>GenericModelEngine Class Template Reference</h1><!-- doxytag: class="QuantLib::GenericModelEngine" --><!-- doxytag: inherits="QuantLib::GenericEngine" --><code>#include &lt;ql/pricingengines/genericmodelengine.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for GenericModelEngine:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_generic_model_engine__inherit__graph.png" border="0" usemap="#_generic_model_engine__inherit__map" alt="Inheritance graph"></center>
<map name="_generic_model_engine__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_analytic_b_s_m_hull_white_engine.html" title="analytic european option pricer including stochastic interest rates" alt="" coords="671,33,1343,60"><area shape="rect" href="class_quant_lib_1_1_analytic_cap_floor_engine.html" title="Analytic engine for cap/floor." alt="" coords="628,84,1385,111"><area shape="rect" href="class_quant_lib_1_1_analytic_heston_engine.html" title="analytic Heston&#45;model engine based on Fourier transform" alt="" coords="680,135,1333,161"><area shape="rect" href="class_quant_lib_1_1_g2_swaption_engine.html" title="Swaption priced by means of the Black formula" alt="" coords="712,185,1301,212"><area shape="rect" href="class_quant_lib_1_1_jamshidian_swaption_engine.html" title="Jamshidian swaption engine." alt="" coords="584,236,1429,263"><area shape="rect" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html" title="Engine for a short&#45;rate model specialized on a lattice." alt="" coords="732,287,1281,313"><area shape="rect" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html" title="LatticeShortRateModelEngine\&lt; QuantLib::CapFloor::arguments, CapFloor::results \&gt;" alt="" coords="724,337,1289,364"><area shape="rect" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html" title="LatticeShortRateModelEngine\&lt; QuantLib::Swaption::arguments, Swaption::results \&gt;" alt="" coords="723,388,1291,415"><area shape="rect" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html" title="LatticeShortRateModelEngine\&lt; QuantLib::VanillaSwap::arguments, QuantLib::VanillaSwap::results \&gt;" alt="" coords="673,439,1340,465"><area shape="rect" href="class_quant_lib_1_1_lfm_swaption_engine.html" title="Libor forward model swaption engine based on Black formula" alt="" coords="616,489,1397,516"><area shape="rect" href="class_quant_lib_1_1_generic_engine.html" title="template base class for option pricing engines" alt="" coords="7,261,332,288"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_generic_model_engine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ModelType, class ArgumentsType, class ResultsType&gt;<br>
 class QuantLib::GenericModelEngine&lt; ModelType, ArgumentsType, ResultsType &gt;</h3>

Base class for some pricing engine on a particular model. 
<p>
Derived engines only need to implement the <code>calculate()</code> method <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="5761f8fc721622d3924cfd84b297e363"></a><!-- doxytag: member="QuantLib::GenericModelEngine::GenericModelEngine" ref="5761f8fc721622d3924cfd84b297e363" args="(const boost::shared_ptr&lt; ModelType &gt; &amp;model)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>GenericModelEngine</b> (const boost::shared_ptr&lt; ModelType &gt; &amp;model)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a971b7c9c6155c3945fa67e1f3351e2"></a><!-- doxytag: member="QuantLib::GenericModelEngine::setModel" ref="4a971b7c9c6155c3945fa67e1f3351e2" args="(const boost::shared_ptr&lt; ModelType &gt; &amp;model)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setModel</b> (const boost::shared_ptr&lt; ModelType &gt; &amp;model)</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="a31da6fe5760fda3522db411ab4fc57d"></a><!-- doxytag: member="QuantLib::GenericModelEngine::model_" ref="a31da6fe5760fda3522db411ab4fc57d" args="" -->
boost::shared_ptr&lt; ModelType &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>model_</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>