File: class_quant_lib_1_1_constant_optionlet_volatility.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 (146 lines) | stat: -rw-r--r-- 14,896 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
<!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>ConstantOptionletVolatility 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_constant_optionlet_volatility.html">ConstantOptionletVolatility</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">ConstantOptionletVolatility Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ConstantOptionletVolatility" --><!-- doxytag: inherits="QuantLib::OptionletVolatilityStructure" -->
<p>Constant caplet volatility, no time-strike dependence.  
 <a href="class_quant_lib_1_1_constant_optionlet_volatility.html#details">More...</a></p>

<p><code>#include &lt;ql/termstructures/volatility/optionlet/constantoptionletvol.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ConstantOptionletVolatility:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_constant_optionlet_volatility__inherit__graph.png" border="0" usemap="#_constant_optionlet_volatility_inherit__map" alt="Inheritance graph"/></div>
<map name="_constant_optionlet_volatility_inherit__map" id="_constant_optionlet_volatility_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_optionlet_volatility_structure.html" title="Optionlet (caplet/floorlet) volatility structure." alt="" coords="5,6,181,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_constant_optionlet_volatility-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="a67313d8f577245f98e5d9ad63a122d99"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::ConstantOptionletVolatility" ref="a67313d8f577245f98e5d9ad63a122d99" args="(Natural settlementDays, const Calendar &amp;cal, BusinessDayConvention bdc, const Handle&lt; Quote &gt; &amp;volatility, const DayCounter &amp;dc)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constant_optionlet_volatility.html#a67313d8f577245f98e5d9ad63a122d99">ConstantOptionletVolatility</a> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> <a class="el" href="class_quant_lib_1_1_term_structure.html#ab6506da60fec85c6f146f1b43116de70">settlementDays</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;cal, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc, 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;<a class="el" href="class_quant_lib_1_1_optionlet_volatility_structure.html#ad6581b343c19b58d18e3b643265f4f57">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">floating reference date, floating market data <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a798d865b41ca9ac9b3613892d87e16bd"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::ConstantOptionletVolatility" ref="a798d865b41ca9ac9b3613892d87e16bd" args="(const Date &amp;referenceDate, const Calendar &amp;cal, BusinessDayConvention bdc, const Handle&lt; Quote &gt; &amp;volatility, const DayCounter &amp;dc)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constant_optionlet_volatility.html#a798d865b41ca9ac9b3613892d87e16bd">ConstantOptionletVolatility</a> (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>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;cal, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc, 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;<a class="el" href="class_quant_lib_1_1_optionlet_volatility_structure.html#ad6581b343c19b58d18e3b643265f4f57">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixed reference date, floating market data <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2753d14197244e992a79569d04f90927"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::ConstantOptionletVolatility" ref="a2753d14197244e992a79569d04f90927" args="(Natural settlementDays, const Calendar &amp;cal, BusinessDayConvention bdc, Volatility volatility, const DayCounter &amp;dc)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constant_optionlet_volatility.html#a2753d14197244e992a79569d04f90927">ConstantOptionletVolatility</a> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> <a class="el" href="class_quant_lib_1_1_term_structure.html#ab6506da60fec85c6f146f1b43116de70">settlementDays</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;cal, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc, <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> <a class="el" href="class_quant_lib_1_1_optionlet_volatility_structure.html#ad6581b343c19b58d18e3b643265f4f57">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">floating reference date, fixed market data <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ccddfb23110eb2edc5771aeee8b5b0b"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::ConstantOptionletVolatility" ref="a6ccddfb23110eb2edc5771aeee8b5b0b" args="(const Date &amp;referenceDate, const Calendar &amp;cal, BusinessDayConvention bdc, Volatility volatility, const DayCounter &amp;dc)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constant_optionlet_volatility.html#a6ccddfb23110eb2edc5771aeee8b5b0b">ConstantOptionletVolatility</a> (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>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;cal, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> bdc, <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> <a class="el" href="class_quant_lib_1_1_optionlet_volatility_structure.html#ad6581b343c19b58d18e3b643265f4f57">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixed reference date, fixed market data <br/></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="a74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::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_constant_optionlet_volatility.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::ConstantOptionletVolatility::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_constant_optionlet_volatility.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::ConstantOptionletVolatility::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_constant_optionlet_volatility.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"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f6adb992ee1324a8ad4ed8e7e18fcad"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::smileSectionImpl" ref="a0f6adb992ee1324a8ad4ed8e7e18fcad" args="(const Date &amp;d) const " -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_smile_section.html">SmileSection</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>smileSectionImpl</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93c505c12c2788be4e6614ba5b30ccff"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::smileSectionImpl" ref="a93c505c12c2788be4e6614ba5b30ccff" args="(Time) const " -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_smile_section.html">SmileSection</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constant_optionlet_volatility.html#a93c505c12c2788be4e6614ba5b30ccff">smileSectionImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">implements the actual smile calculation in derived classes <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4e9e187b4dc3afd9d30a9c07c2e1737"></a><!-- doxytag: member="QuantLib::ConstantOptionletVolatility::volatilityImpl" ref="ac4e9e187b4dc3afd9d30a9c07c2e1737" args="(Time, Rate) const " -->
<a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_constant_optionlet_volatility.html#ac4e9e187b4dc3afd9d30a9c07c2e1737">volatilityImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">implements the actual volatility calculation in derived classes <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Constant caplet volatility, no time-strike dependence. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_bonds_8cpp-example.html#_a46">Bonds.cpp</a>.</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>