File: class_quant_lib_1_1_swaption_constant_volatility.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 (143 lines) | stat: -rw-r--r-- 13,959 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
<!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: 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.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_swaption_constant_volatility.html">SwaptionConstantVolatility</a></div>
<h1>SwaptionConstantVolatility Class Reference</h1><!-- doxytag: class="QuantLib::SwaptionConstantVolatility" --><!-- doxytag: inherits="QuantLib::SwaptionVolatilityStructure" --><code>#include &lt;ql/termstructures/volatility/swaption/swaptionconstantvol.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for SwaptionConstantVolatility:</div>
<div class="dynsection">
<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 shape="rect" href="class_quant_lib_1_1_swaption_volatility_structure.html" title="Swaption&#45;volatility structure" alt="" coords="5,7,200,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<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. <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="ab612f40ee132a09e19f67c16e502cdb"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxSwapTenor" ref="ab612f40ee132a09e19f67c16e502cdb" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#ab612f40ee132a09e19f67c16e502cdb">maxSwapTenor</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="38b52da2964337ebb4d219b5dc5c2a3f"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxSwapLength" ref="38b52da2964337ebb4d219b5dc5c2a3f" args="() const " -->
<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#38b52da2964337ebb4d219b5dc5c2a3f">maxSwapLength</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the largest swapLength for which the term structure can return vols <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec700319eaa1c6fca66df8e15aea6167"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::minStrike" ref="ec700319eaa1c6fca66df8e15aea6167" 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#ec700319eaa1c6fca66df8e15aea6167">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="be69dc8630a5ea3f8333cfdfd01ba765"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxStrike" ref="be69dc8630a5ea3f8333cfdfd01ba765" 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#be69dc8630a5ea3f8333cfdfd01ba765">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="47909aba7db97bc5c0f7488dd5aff4da"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::volatilityImpl" ref="47909aba7db97bc5c0f7488dd5aff4da" args="(Time, Time, Rate) const " -->
<a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_swaption_constant_volatility.html#47909aba7db97bc5c0f7488dd5aff4da">volatilityImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>) 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="04f2608add446a8af9cfe54291488e82"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::smileSectionImpl" ref="04f2608add446a8af9cfe54291488e82" args="(Time optionTime, Time swapLength) 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#04f2608add446a8af9cfe54291488e82">smileSectionImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> optionTime, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> swapLength) 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="0ae7b5a492d2300c7aedd3a0885d7d19"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::volatilityImpl" ref="0ae7b5a492d2300c7aedd3a0885d7d19" args="(const Date &amp;, const Period &amp;, Rate) const " -->
<a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a>&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;, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>) 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, <a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> 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="71f6bdb8addd9e55116e66e18a7ae767"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::SwaptionConstantVolatility" ref="71f6bdb8addd9e55116e66e18a7ae767" args="(Natural settlementDays, const Calendar &amp;, Volatility volatility, const DayCounter &amp;dayCounter)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SwaptionConstantVolatility</b> (<a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;, <a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> 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="030866448b69907c85ca239fa1c9d931"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::SwaptionConstantVolatility" ref="030866448b69907c85ca239fa1c9d931" args="(Natural 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> (<a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> 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="c147d63df367bbe5282b76b1f98cb9be"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::dayCounter" ref="c147d63df367bbe5282b76b1f98cb9be" 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#c147d63df367bbe5282b76b1f98cb9be">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>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::SwaptionConstantVolatility::maxDate" ref="74d8fc5480ca811db8332b7b30597fe9" 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#74d8fc5480ca811db8332b7b30597fe9">maxDate</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the latest date for which the curve can return values <br></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>