File: class_quant_lib_1_1_swaption_constant_volatility.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (173 lines) | stat: -rw-r--r-- 15,320 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: SwaptionConstantVolatility 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="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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html">SwaptionConstantVolatility</a></div>
<h1>SwaptionConstantVolatility Class Reference</h1><!-- doxytag: class="QuantLib::SwaptionConstantVolatility" --><!-- doxytag: inherits="QuantLib::SwaptionVolatilityStructure" --><code>#include &lt;ql/Volatilities/swaptionconstantvol.hpp&gt;</code>
<p>
Inheritance diagram for SwaptionConstantVolatility:<p><center><img src="class_quant_lib_1_1_swaption_constant_volatility__inherit__graph.png" border="0" usemap="#_swaption_constant_volatility__inherit__map" alt="Inheritance graph"></center>
<map name="_swaption_constant_volatility__inherit__map">
<area href="class_quant_lib_1_1_swaption_volatility_structure.html" shape="rect" coords="59,156,264,180" alt="">
<area href="class_quant_lib_1_1_term_structure.html" shape="rect" coords="103,81,220,105" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="5,7,88,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="112,7,211,31" alt="">
<area href="class_quant_lib_1_1_extrapolator.html" shape="rect" coords="235,7,339,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_swaption_constant_volatility-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Constant swaption volatility, no time-strike dependence. 
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>SwaptionConstantVolatility interface</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbce30aded8302a5a47dfa9454699ce5"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxStartDate" ref="fbce30aded8302a5a47dfa9454699ce5" args="() const" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#fbce30aded8302a5a47dfa9454699ce5">maxStartDate</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the latest start date for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d86f95f9631dd987c50df571a40353b"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxStartTime" ref="1d86f95f9631dd987c50df571a40353b" args="() const" -->
Time&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#1d86f95f9631dd987c50df571a40353b">maxStartTime</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the latest start time for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e73a828556c9fead978806dddb20ca7"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxLength" ref="8e73a828556c9fead978806dddb20ca7" args="() const" -->
<a class="el" href="class_quant_lib_1_1_period.html">Period</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#8e73a828556c9fead978806dddb20ca7">maxLength</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the largest length for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e275a9cb50e4ac17eb82e57110738e7"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxTimeLength" ref="6e275a9cb50e4ac17eb82e57110738e7" args="() const" -->
Time&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#6e275a9cb50e4ac17eb82e57110738e7">maxTimeLength</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the largest length for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08611adcd4c1461233257e6ff17c582a"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::minStrike" ref="08611adcd4c1461233257e6ff17c582a" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#08611adcd4c1461233257e6ff17c582a">minStrike</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the minimum strike for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e78ef8a9ed6ba66165705dc96b8d5bf"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxStrike" ref="4e78ef8a9ed6ba66165705dc96b8d5bf" args="() const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#4e78ef8a9ed6ba66165705dc96b8d5bf">maxStrike</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the maximum strike for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d2ca42358f25fa7e9ac0b1f9ed9ab0e"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::smileSection" ref="9d2ca42358f25fa7e9ac0b1f9ed9ab0e" args="(const Date &amp;start, const Period &amp;length) const" -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_smile_section.html">SmileSection</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#9d2ca42358f25fa7e9ac0b1f9ed9ab0e">smileSection</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;start, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;length) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return trivial smile section <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e2c286f2902ba3b56cb75bd84c02b44"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::volatilityImpl" ref="2e2c286f2902ba3b56cb75bd84c02b44" args="(Time, Time, Rate) const" -->
Volatility&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#2e2c286f2902ba3b56cb75bd84c02b44">volatilityImpl</a> (Time, Time, Rate) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">implements the actual volatility calculation in derived classes <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a1df09e79c73fe52be83d290cc169d7"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::smileSection" ref="5a1df09e79c73fe52be83d290cc169d7" args="(Time start, Time length) const" -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_smile_section.html">SmileSection</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#5a1df09e79c73fe52be83d290cc169d7">smileSection</a> (Time start, Time length) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return smile section <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bfcbbb43928ee55c3e3bc80512fa3c6b"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::volatilityImpl" ref="bfcbbb43928ee55c3e3bc80512fa3c6b" args="(const Date &amp;, const Period &amp;, Rate) const" -->
Volatility&nbsp;</td><td class="memItemRight" valign="bottom"><b>volatilityImpl</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;, Rate) const</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="58fc6fd515092eb8d41cddefe4f296d3"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::SwaptionConstantVolatility" ref="58fc6fd515092eb8d41cddefe4f296d3" args="(const Date &amp;referenceDate, Volatility volatility, const DayCounter &amp;dayCounter)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SwaptionConstantVolatility</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate, Volatility volatility, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7b54b18fefc8e5d13039b27d71015ca"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::SwaptionConstantVolatility" ref="a7b54b18fefc8e5d13039b27d71015ca" args="(const Date &amp;referenceDate, const Handle&lt; Quote &gt; &amp;volatility, const DayCounter &amp;dayCounter)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SwaptionConstantVolatility</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate, 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;volatility, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2788ca0dd35e2b8c0415b17107ad8a7c"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::SwaptionConstantVolatility" ref="2788ca0dd35e2b8c0415b17107ad8a7c" args="(Integer settlementDays, const Calendar &amp;, Volatility volatility, const DayCounter &amp;dayCounter)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SwaptionConstantVolatility</b> (Integer settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;, Volatility volatility, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9552e4326c8ce559a28baa3bb08eb4c"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::SwaptionConstantVolatility" ref="c9552e4326c8ce559a28baa3bb08eb4c" args="(Integer settlementDays, const Calendar &amp;, const Handle&lt; Quote &gt; &amp;volatility, const DayCounter &amp;dayCounter)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SwaptionConstantVolatility</b> (Integer settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &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_quote.html">Quote</a> &gt; &amp;volatility, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter)</td></tr>

<tr><td colspan="2"><div class="groupHeader">TermStructure interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d49654ea33055b03f8666910acc13880"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::dayCounter" ref="d49654ea33055b03f8666910acc13880" args="() const" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#d49654ea33055b03f8666910acc13880">dayCounter</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the day counter used for date/time conversion <br></td></tr>
</table>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>