File: class_quant_lib_1_1_quanto_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 (127 lines) | stat: -rw-r--r-- 8,095 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
<!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: QuantoEngine 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_quanto_engine.html">QuantoEngine</a></div>
<h1>QuantoEngine Class Template Reference<br>
<small>
[<a class="el" href="group__quantoengines.html">Quanto option engines</a>]</small>
</h1><!-- doxytag: class="QuantLib::QuantoEngine" --><!-- doxytag: inherits="QuantLib::GenericEngine" --><code>#include &lt;ql/pricingengines/quanto/quantoengine.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for QuantoEngine:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_quanto_engine__inherit__graph.png" border="0" usemap="#_quanto_engine__inherit__map" alt="Inheritance graph"></center>
<map name="_quanto_engine__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_generic_engine.html" title="template base class for option pricing engines" alt="" coords="5,5,579,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

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

Quanto engine. 
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000083">Warning:</a></b></dt><dd>for the time being, this engine will only work with simple Black-Scholes processes (i.e., no Merton.)</dd></dl>
<p>
<dl compact><dt><b><a class="el" href="test.html#_test000092">Tests:</a></b></dt><dd><ul>
<li>the correctness of the returned value is tested by reproducing results available in literature.</li><li>the correctness of the returned greeks is tested by reproducing numerical derivatives. </li></ul>
</dd></dl>
<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="8d6555125db227d0efd26de75031613b"></a><!-- doxytag: member="QuantLib::QuantoEngine::QuantoEngine" ref="8d6555125db227d0efd26de75031613b" args="(const boost::shared_ptr&lt; GeneralizedBlackScholesProcess &gt; &amp;, const Handle&lt; YieldTermStructure &gt; &amp;foreignRiskFreeRate, const Handle&lt; BlackVolTermStructure &gt; &amp;exchangeRateVolatility, const Handle&lt; Quote &gt; &amp;correlation)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>QuantoEngine</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> &gt; &amp;, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;foreignRiskFreeRate, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> &gt; &amp;exchangeRateVolatility, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &amp;correlation)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10873979f635888606e03f9cb2d8a096"></a><!-- doxytag: member="QuantLib::QuantoEngine::calculate" ref="10873979f635888606e03f9cb2d8a096" args="() const " -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>calculate</b> () const </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="56894d395192aaae9970e5f03c5ad02f"></a><!-- doxytag: member="QuantLib::QuantoEngine::process_" ref="56894d395192aaae9970e5f03c5ad02f" args="" -->
boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>process_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="115031ddc05d2c8bd162f615a6e8a4f2"></a><!-- doxytag: member="QuantLib::QuantoEngine::foreignRiskFreeRate_" ref="115031ddc05d2c8bd162f615a6e8a4f2" args="" -->
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>foreignRiskFreeRate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1c2bc20bc9b5f0ebc98b57b92c21bc9"></a><!-- doxytag: member="QuantLib::QuantoEngine::exchangeRateVolatility_" ref="d1c2bc20bc9b5f0ebc98b57b92c21bc9" args="" -->
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_black_vol_term_structure.html">BlackVolTermStructure</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>exchangeRateVolatility_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0bbb8459d54c70260f5dc06646c622fe"></a><!-- doxytag: member="QuantLib::QuantoEngine::correlation_" ref="0bbb8459d54c70260f5dc06646c622fe" args="" -->
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>correlation_</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>