File: class_quant_lib_1_1_quanto_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 (136 lines) | stat: -rw-r--r-- 8,887 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
<!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>QuantoEngine&lt; Instr, Engine &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_quanto_engine.html">QuantoEngine</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">QuantoEngine&lt; Instr, Engine &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__quantoengines.html">Quanto option engines</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::QuantoEngine" --><!-- doxytag: inherits="GenericEngine&lt; Instr::arguments, QuantoOptionResults&lt; Instr::results &gt; &gt;" -->
<p>Quanto engine.  
 <a href="class_quant_lib_1_1_quanto_engine.html#details">More...</a></p>

<p><code>#include &lt;ql/pricingengines/quanto/quantoengine.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QuantoEngine&lt; Instr, Engine &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_quanto_engine__inherit__graph.png" border="0" usemap="#_quanto_engine_3_01_instr_00_01_engine_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_quanto_engine_3_01_instr_00_01_engine_01_4_inherit__map" id="_quanto_engine_3_01_instr_00_01_engine_01_4_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_generic_engine.html" title="GenericEngine\&lt; Instr::arguments, QuantoOptionResults\&lt; Instr::results \&gt; \&gt;" alt="" coords="5,6,459,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_quanto_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="a8d6555125db227d0efd26de75031613b"></a><!-- doxytag: member="QuantLib::QuantoEngine::QuantoEngine" ref="a8d6555125db227d0efd26de75031613b" 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)" -->
&#160;</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" align="right" valign="top"><a class="anchor" id="a10873979f635888606e03f9cb2d8a096"></a><!-- doxytag: member="QuantLib::QuantoEngine::calculate" ref="a10873979f635888606e03f9cb2d8a096" args="() const " -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>calculate</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56894d395192aaae9970e5f03c5ad02f"></a><!-- doxytag: member="QuantLib::QuantoEngine::process_" ref="a56894d395192aaae9970e5f03c5ad02f" args="" -->
boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html">GeneralizedBlackScholesProcess</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>process_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a115031ddc05d2c8bd162f615a6e8a4f2"></a><!-- doxytag: member="QuantLib::QuantoEngine::foreignRiskFreeRate_" ref="a115031ddc05d2c8bd162f615a6e8a4f2" 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;&#160;</td><td class="memItemRight" valign="bottom"><b>foreignRiskFreeRate_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1c2bc20bc9b5f0ebc98b57b92c21bc9"></a><!-- doxytag: member="QuantLib::QuantoEngine::exchangeRateVolatility_" ref="ad1c2bc20bc9b5f0ebc98b57b92c21bc9" 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;&#160;</td><td class="memItemRight" valign="bottom"><b>exchangeRateVolatility_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bbb8459d54c70260f5dc06646c622fe"></a><!-- doxytag: member="QuantLib::QuantoEngine::correlation_" ref="a0bbb8459d54c70260f5dc06646c622fe" 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;&#160;</td><td class="memItemRight" valign="bottom"><b>correlation_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Instr, class Engine&gt;<br/>
class QuantLib::QuantoEngine&lt; Instr, Engine &gt;</h3>

<p>Quanto engine. </p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000098">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>
<dl class="test"><dt><b><a class="el" href="test.html#_test000108">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>
</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>