File: class_quant_lib_1_1_callable_bond_constant_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 (148 lines) | stat: -rw-r--r-- 16,004 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
<!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>CallableBondConstantVolatility 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_callable_bond_constant_volatility.html">CallableBondConstantVolatility</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CallableBondConstantVolatility Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::CallableBondConstantVolatility" --><!-- doxytag: inherits="QuantLib::CallableBondVolatilityStructure" -->
<p>Constant callable-bond volatility, no time-strike dependence.  
 <a href="class_quant_lib_1_1_callable_bond_constant_volatility.html#details">More...</a></p>

<p><code>#include &lt;ql/experimental/callablebonds/callablebondconstantvol.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CallableBondConstantVolatility:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_callable_bond_constant_volatility__inherit__graph.png" border="0" usemap="#_callable_bond_constant_volatility_inherit__map" alt="Inheritance graph"/></div>
<map name="_callable_bond_constant_volatility_inherit__map" id="_callable_bond_constant_volatility_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_callable_bond_volatility_structure.html" title="Callable&#45;bond volatility structure." alt="" coords="5,6,205,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_callable_bond_constant_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="afa4061e2c92fd12d1cd25942355b70c1"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::CallableBondConstantVolatility" ref="afa4061e2c92fd12d1cd25942355b70c1" args="(const Date &amp;referenceDate, Volatility volatility, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>CallableBondConstantVolatility</b> (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>, <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> <a class="el" href="class_quant_lib_1_1_callable_bond_volatility_structure.html#af9fbf120adada072dc64ec8a1b00e267">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;<a class="el" href="class_quant_lib_1_1_callable_bond_constant_volatility.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70946fb2c5f6a2637486a04e1e8c1152"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::CallableBondConstantVolatility" ref="a70946fb2c5f6a2637486a04e1e8c1152" args="(const Date &amp;referenceDate, const Handle&lt; Quote &gt; &amp;volatility, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>CallableBondConstantVolatility</b> (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_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_callable_bond_volatility_structure.html#af9fbf120adada072dc64ec8a1b00e267">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;<a class="el" href="class_quant_lib_1_1_callable_bond_constant_volatility.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b909f742a1de122e5ad98561c672007"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::CallableBondConstantVolatility" ref="a2b909f742a1de122e5ad98561c672007" args="(Natural settlementDays, const Calendar &amp;, Volatility volatility, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>CallableBondConstantVolatility</b> (<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;, <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> <a class="el" href="class_quant_lib_1_1_callable_bond_volatility_structure.html#af9fbf120adada072dc64ec8a1b00e267">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;<a class="el" href="class_quant_lib_1_1_callable_bond_constant_volatility.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a281345af118d31c01c35f2b2870d4587"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::CallableBondConstantVolatility" ref="a281345af118d31c01c35f2b2870d4587" args="(Natural settlementDays, const Calendar &amp;, const Handle&lt; Quote &gt; &amp;volatility, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>CallableBondConstantVolatility</b> (<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;, 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_callable_bond_volatility_structure.html#af9fbf120adada072dc64ec8a1b00e267">volatility</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;<a class="el" href="class_quant_lib_1_1_callable_bond_constant_volatility.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</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::CallableBondConstantVolatility::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_callable_bond_constant_volatility.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::CallableBondConstantVolatility::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_callable_bond_constant_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"><h2><a name="member-group"></a>
CallableBondConstantVolatility interface</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a222e287d5aaa40149f1f067f1beceadb"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::maxBondTenor" ref="a222e287d5aaa40149f1f067f1beceadb" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond_constant_volatility.html#a222e287d5aaa40149f1f067f1beceadb">maxBondTenor</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the largest length for which the term structure can return vols <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeddd916230722ca9ad5f39884802d280"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::maxBondLength" ref="aeddd916230722ca9ad5f39884802d280" args="() const " -->
<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond_constant_volatility.html#aeddd916230722ca9ad5f39884802d280">maxBondLength</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the largest bondLength for which the term structure can return vols <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec700319eaa1c6fca66df8e15aea6167"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::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_callable_bond_constant_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::CallableBondConstantVolatility::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_callable_bond_constant_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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47909aba7db97bc5c0f7488dd5aff4da"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::volatilityImpl" ref="a47909aba7db97bc5c0f7488dd5aff4da" args="(Time, 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_callable_bond_constant_volatility.html#a47909aba7db97bc5c0f7488dd5aff4da">volatilityImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb4caa90bf5be93d7aafe6d04a038315"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::smileSectionImpl" ref="acb4caa90bf5be93d7aafe6d04a038315" args="(Time optionTime, Time bondLength) 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_callable_bond_constant_volatility.html#acb4caa90bf5be93d7aafe6d04a038315">smileSectionImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> optionTime, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> bondLength) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return smile section <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ae7b5a492d2300c7aedd3a0885d7d19"></a><!-- doxytag: member="QuantLib::CallableBondConstantVolatility::volatilityImpl" ref="a0ae7b5a492d2300c7aedd3a0885d7d19" args="(const Date &amp;, const Period &amp;, Rate) const " -->
<a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a>&#160;</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#gaede435af51236692b1107d7639581d39">Rate</a>) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Constant callable-bond volatility, no time-strike dependence. </p>
</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>