File: class_quant_lib_1_1_implied_vol_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 (139 lines) | stat: -rw-r--r-- 10,086 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
<!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>ImpliedVolTermStructure 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_implied_vol_term_structure.html">ImpliedVolTermStructure</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">ImpliedVolTermStructure Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ImpliedVolTermStructure" --><!-- doxytag: inherits="QuantLib::BlackVarianceTermStructure" -->
<p>Implied vol term structure at a given date in the future.  
 <a href="class_quant_lib_1_1_implied_vol_term_structure.html#details">More...</a></p>

<p><code>#include &lt;ql/termstructures/volatility/equityfx/impliedvoltermstructure.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ImpliedVolTermStructure:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_implied_vol_term_structure__inherit__graph.png" border="0" usemap="#_implied_vol_term_structure_inherit__map" alt="Inheritance graph"/></div>
<map name="_implied_vol_term_structure_inherit__map" id="_implied_vol_term_structure_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_black_variance_term_structure.html" title="Black variance term structure." alt="" coords="5,6,192,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_implied_vol_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="a02a9b8aeaad6b9883a33b67849fd0461"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::ImpliedVolTermStructure" ref="a02a9b8aeaad6b9883a33b67849fd0461" args="(const Handle&lt; BlackVolTermStructure &gt; &amp;origTS, const Date &amp;referenceDate)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ImpliedVolTermStructure</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_black_vol_term_structure.html">BlackVolTermStructure</a> &gt; &amp;origTS, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#aa9ae6cc6009ac64d4f265065eab08be0">referenceDate</a>)</td></tr>
<tr><td colspan="2"><div class="groupHeader">TermStructure interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac147d63df367bbe5282b76b1f98cb9be"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::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_implied_vol_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="a74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::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_implied_vol_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"><div class="groupHeader">VolatilityTermStructure interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec700319eaa1c6fca66df8e15aea6167"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::minStrike" ref="aec700319eaa1c6fca66df8e15aea6167" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_implied_vol_term_structure.html#aec700319eaa1c6fca66df8e15aea6167">minStrike</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the minimum strike for which the term structure can return vols <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe69dc8630a5ea3f8333cfdfd01ba765"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::maxStrike" ref="abe69dc8630a5ea3f8333cfdfd01ba765" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_implied_vol_term_structure.html#abe69dc8630a5ea3f8333cfdfd01ba765">maxStrike</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the maximum strike for which the term structure can return vols <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d7eaf2f5dccce1c7781b54d64ba4a07"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::accept" ref="a1d7eaf2f5dccce1c7781b54d64ba4a07" args="(AcyclicVisitor &amp;)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &amp;)</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="aa1d54e6aae7eded3d225f318ea0809e8"></a><!-- doxytag: member="QuantLib::ImpliedVolTermStructure::blackVarianceImpl" ref="aa1d54e6aae7eded3d225f318ea0809e8" args="(Time t, Real strike) const " -->
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_implied_vol_term_structure.html#aa1d54e6aae7eded3d225f318ea0809e8">blackVarianceImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Black variance calculation. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implied vol term structure at a given date in the future. </p>
<p>The given date will be the implied reference date. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This term structure will remain linked to the original structure, i.e., any changes in the latter will be reflected in this structure as well.</dd></dl>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000123">Warning:</a></b></dt><dd>It doesn't make financial sense to have an asset-dependant implied Vol Term Structure. This class should be used with term structures that are time dependant only. </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>