File: class_quant_lib_1_1_quanto_term_structure.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 (137 lines) | stat: -rw-r--r-- 10,773 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
<!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>QuantoTermStructure Class 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_term_structure.html">QuantoTermStructure</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">QuantoTermStructure Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::QuantoTermStructure" --><!-- doxytag: inherits="QuantLib::ZeroYieldStructure" -->
<p>Quanto term structure.  
 <a href="class_quant_lib_1_1_quanto_term_structure.html#details">More...</a></p>

<p><code>#include &lt;ql/termstructures/yield/quantotermstructure.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QuantoTermStructure:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_quanto_term_structure__inherit__graph.png" border="0" usemap="#_quanto_term_structure_inherit__map" alt="Inheritance graph"/></div>
<map name="_quanto_term_structure_inherit__map" id="_quanto_term_structure_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_zero_yield_structure.html" title="Zero&#45;yield term structure." alt="" coords="15,6,143,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_term_structure-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="a8a492ca4a04a52b27abb13989ea942ca"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::QuantoTermStructure" ref="a8a492ca4a04a52b27abb13989ea942ca" args="(const Handle&lt; YieldTermStructure &gt; &amp;underlyingDividendTS, const Handle&lt; YieldTermStructure &gt; &amp;riskFreeTS, const Handle&lt; YieldTermStructure &gt; &amp;foreignRiskFreeTS, const Handle&lt; BlackVolTermStructure &gt; &amp;underlyingBlackVolTS, Real strike, const Handle&lt; BlackVolTermStructure &gt; &amp;exchRateBlackVolTS, Real exchRateATMlevel, Real underlyingExchRateCorrelation)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>QuantoTermStructure</b> (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;underlyingDividendTS, 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;riskFreeTS, 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;foreignRiskFreeTS, 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;underlyingBlackVolTS, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike, 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;exchRateBlackVolTS, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> exchRateATMlevel, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> underlyingExchRateCorrelation)</td></tr>
<tr><td colspan="2"><div class="groupHeader">YieldTermStructure interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac147d63df367bbe5282b76b1f98cb9be"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::dayCounter" ref="ac147d63df367bbe5282b76b1f98cb9be" args="() const " -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_quanto_term_structure.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the day counter used for date/time conversion <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9a0f3904cff2fe61596c593dd0b6448"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::calendar" ref="ae9a0f3904cff2fe61596c593dd0b6448" args="() const " -->
<a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_quanto_term_structure.html#ae9a0f3904cff2fe61596c593dd0b6448">calendar</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the calendar used for reference and/or option date calculation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6506da60fec85c6f146f1b43116de70"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::settlementDays" ref="ab6506da60fec85c6f146f1b43116de70" args="() const " -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_quanto_term_structure.html#ab6506da60fec85c6f146f1b43116de70">settlementDays</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the settlementDays used for reference date calculation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5662908c63119a3b347a7e0ec8544afa"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::referenceDate" ref="a5662908c63119a3b347a7e0ec8544afa" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_quanto_term_structure.html#a5662908c63119a3b347a7e0ec8544afa">referenceDate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the date at which discount = 1.0 and/or variance = 0.0 <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::maxDate" ref="a74d8fc5480ca811db8332b7b30597fe9" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_quanto_term_structure.html#a74d8fc5480ca811db8332b7b30597fe9">maxDate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the latest date for which the curve can return values <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5fe572646475bf02f83c3bedfca9a61"></a><!-- doxytag: member="QuantLib::QuantoTermStructure::zeroYieldImpl" ref="ac5fe572646475bf02f83c3bedfca9a61" args="(Time) const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_quanto_term_structure.html#ac5fe572646475bf02f83c3bedfca9a61">zeroYieldImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the zero yield as seen from the evaluation date <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Quanto term structure. </p>
<p>Quanto term structure for modelling quanto effect in option pricing.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This term structure will remain linked to the original structures, i.e., any changes in the latters will be reflected in this structure as well. </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>