File: class_quant_lib_1_1_generic_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 (141 lines) | stat: -rw-r--r-- 10,319 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
<!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: GenericEngine 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_engine.html">GenericEngine</a></div>
<h1>GenericEngine Class Template Reference</h1><!-- doxytag: class="QuantLib::GenericEngine" --><!-- doxytag: inherits="QuantLib::PricingEngine,QuantLib::Observer" --><code>#include &lt;ql/pricingengine.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for GenericEngine:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_generic_engine__inherit__graph.png" border="0" usemap="#_generic_engine__inherit__map" alt="Inheritance graph"></center>
<map name="_generic_engine__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_barrier_option_1_1engine.html" title="Barrier&#45;option engine base class" alt="" coords="468,37,937,64"><area shape="rect" href="class_quant_lib_1_1_cap_floor_1_1engine.html" title="base class for cap/floor engines" alt="" coords="496,88,909,115"><area shape="rect" href="class_quant_lib_1_1_cliquet_option_1_1engine.html" title="Cliquet engine base class." alt="" coords="467,139,939,165"><area shape="rect" href="class_quant_lib_1_1_continuous_averaging_asian_option_1_1engine.html" title="Continuous&#45;averaging Asian engine base class." alt="" coords="340,189,1065,216"><area shape="rect" href="class_quant_lib_1_1_continuous_fixed_lookback_option_1_1engine.html" title="Continuous fixed lookback engine base class" alt="" coords="345,240,1060,267"><area shape="rect" href="class_quant_lib_1_1_continuous_floating_lookback_option_1_1engine.html" title="Continuous floating lookback engine base class" alt="" coords="328,291,1077,317"><area shape="rect" href="class_quant_lib_1_1_discrete_averaging_asian_option_1_1engine.html" title="Discrete&#45;averaging Asian engine base class." alt="" coords="360,341,1045,368"><area shape="rect" href="class_quant_lib_1_1_dividend_vanilla_option_1_1engine.html" title="Dividend&#45;vanilla&#45;option engine base class" alt="" coords="416,392,989,419"><area shape="rect" href="class_quant_lib_1_1_forward_vanilla_engine.html" title="Forward engine for vanilla options" alt="" coords="325,443,1080,469"><area shape="rect" href="class_quant_lib_1_1_generic_model_engine.html" title="Base class for some pricing engine on a particular model." alt="" coords="520,493,885,520"><area shape="rect" href="class_quant_lib_1_1_m_c_longstaff_schwartz_engine.html" title="Longstaff&#45;Schwarz Monte Carlo engine for early exercise options." alt="" coords="597,544,808,571"><area shape="rect" href="class_quant_lib_1_1_quanto_engine.html" title="Quanto engine." alt="" coords="417,595,988,621"><area shape="rect" href="class_quant_lib_1_1_swaption_1_1engine.html" title="base class for swaption engines" alt="" coords="495,645,911,672"><area shape="rect" href="class_quant_lib_1_1_variance_swap_1_1engine.html" title="base class for variance&#45;swap engines" alt="" coords="431,696,975,723"><area shape="rect" href="class_quant_lib_1_1_pricing_engine.html" title="interface for pricing engines" alt="" coords="7,341,113,368"><area shape="rect" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="20,392,100,419"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

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

template base class for option pricing engines 
<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="8203e2bb2b5d6673a84a7bec39346ea5"></a><!-- doxytag: member="QuantLib::GenericEngine::getArguments" ref="8203e2bb2b5d6673a84a7bec39346ea5" args="() const " -->
PricingEngine::arguments *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getArguments</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="957a6482d3d97ecb17f7de2c13024f2c"></a><!-- doxytag: member="QuantLib::GenericEngine::getResults" ref="957a6482d3d97ecb17f7de2c13024f2c" args="() const " -->
const PricingEngine::results *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getResults</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d20897c5c8bd47f5d4005989bead0e55"></a><!-- doxytag: member="QuantLib::GenericEngine::reset" ref="d20897c5c8bd47f5d4005989bead0e55" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_generic_engine.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</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="fee5e1b26214353757b120d9f5ad2169"></a><!-- doxytag: member="QuantLib::GenericEngine::arguments_" ref="fee5e1b26214353757b120d9f5ad2169" args="" -->
ArgumentsType&nbsp;</td><td class="memItemRight" valign="bottom"><b>arguments_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c34e18c69939ed8140f8cccc00ace941"></a><!-- doxytag: member="QuantLib::GenericEngine::results_" ref="c34e18c69939ed8140f8cccc00ace941" args="" -->
ResultsType&nbsp;</td><td class="memItemRight" valign="bottom"><b>results_</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::GenericEngine::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void update           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes. 
<p>Implements <a class="el" href="class_quant_lib_1_1_observer.html#99b02345a8a15d3c5ea2844a2253f510">Observer</a>.</p>

<p>Reimplemented in <a class="el" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html#c5c54df7ed3b930268c8d7752c101725">LatticeShortRateModelEngine</a>, <a class="el" href="class_quant_lib_1_1_analytic_heston_hull_white_engine.html#c5c54df7ed3b930268c8d7752c101725">AnalyticHestonHullWhiteEngine</a>, <a class="el" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html#c5c54df7ed3b930268c8d7752c101725">LatticeShortRateModelEngine&lt; QuantLib::VanillaSwap::arguments, QuantLib::VanillaSwap::results &gt;</a>, <a class="el" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html#c5c54df7ed3b930268c8d7752c101725">LatticeShortRateModelEngine&lt; QuantLib::Swaption::arguments, Swaption::results &gt;</a>, and <a class="el" href="class_quant_lib_1_1_lattice_short_rate_model_engine.html#c5c54df7ed3b930268c8d7752c101725">LatticeShortRateModelEngine&lt; QuantLib::CapFloor::arguments, CapFloor::results &gt;</a>.</p>

</div>
</div><p>

</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>