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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<!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>CallableBond 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.html">CallableBond</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">CallableBond Class Reference<div class="ingroups"><a class="el" href="group__instruments.html">Financial instruments</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::CallableBond" --><!-- doxytag: inherits="QuantLib::Bond" -->
<p>Callable bond base class.
<a href="class_quant_lib_1_1_callable_bond.html#details">More...</a></p>
<p><code>#include <ql/experimental/callablebonds/callablebond.hpp></code></p>
<div class="dynheader">
Inheritance diagram for CallableBond:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_callable_bond__inherit__graph.png" border="0" usemap="#_callable_bond_inherit__map" alt="Inheritance graph"/></div>
<map name="_callable_bond_inherit__map" id="_callable_bond_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_callable_fixed_rate_bond.html" title="callable/puttable fixed rate bond" alt="" coords="5,166,163,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_bond.html" title="Base bond class." alt="" coords="59,6,109,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-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond_1_1engine.html">engine</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">base class for callable fixed rate bond engine <a href="class_quant_lib_1_1_callable_bond_1_1engine.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond_1_1results.html">results</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">results for a callable bond calculation <a href="class_quant_lib_1_1_callable_bond_1_1results.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond.html#a71e3006b83c8b484bc57296fe94bf36d">setupArguments</a> (PricingEngine::arguments *) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a3ec3cbe7dc35593049776f91a87e95"></a><!-- doxytag: member="QuantLib::CallableBond::callability" ref="a0a3ec3cbe7dc35593049776f91a87e95" args="() const " -->
const CallabilitySchedule & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond.html#a0a3ec3cbe7dc35593049776f91a87e95">callability</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the bond's put/call schedule <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Calculations</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond.html#adf862ef9600f7281d63d2d71b9d6a009">impliedVolatility</a> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> targetValue, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &discountCurve, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> maxEvaluations, <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> minVol, <a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> maxVol) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the Black implied forward yield volatility <a href="#adf862ef9600f7281d63d2d71b9d6a009"></a><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="a76cad80a741d08a615d87882a90f209b"></a><!-- doxytag: member="QuantLib::CallableBond::CallableBond" ref="a76cad80a741d08a615d87882a90f209b" args="(Natural settlementDays, const Schedule &schedule, const DayCounter &paymentDayCounter, const Date &issueDate=Date(), const CallabilitySchedule &putCallSchedule=CallabilitySchedule())" -->
 </td><td class="memItemRight" valign="bottom"><b>CallableBond</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &schedule, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &paymentDayCounter, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &issueDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const CallabilitySchedule &putCallSchedule=CallabilitySchedule())</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb22873f87d413d6123c023880f8938f"></a><!-- doxytag: member="QuantLib::CallableBond::paymentDayCounter_" ref="afb22873f87d413d6123c023880f8938f" args="" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> </td><td class="memItemRight" valign="bottom"><b>paymentDayCounter_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae358763dc753768bb42e898365204a9a"></a><!-- doxytag: member="QuantLib::CallableBond::frequency_" ref="ae358763dc753768bb42e898365204a9a" args="" -->
<a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td><td class="memItemRight" valign="bottom"><b>frequency_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b04159115489cebb7d0937a3906da6a"></a><!-- doxytag: member="QuantLib::CallableBond::putCallSchedule_" ref="a0b04159115489cebb7d0937a3906da6a" args="" -->
CallabilitySchedule </td><td class="memItemRight" valign="bottom"><b>putCallSchedule_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab00101915948e919e071e350aaf344db"></a><!-- doxytag: member="QuantLib::CallableBond::blackEngine_" ref="ab00101915948e919e071e350aaf344db" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_pricing_engine.html">PricingEngine</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond.html#ab00101915948e919e071e350aaf344db">blackEngine_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">must be set by derived classes for <a class="el" href="class_quant_lib_1_1_callable_bond.html#adf862ef9600f7281d63d2d71b9d6a009" title="returns the Black implied forward yield volatility">impliedVolatility()</a> to work <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7fc97ae23751dbabc88ac9a0864993f"></a><!-- doxytag: member="QuantLib::CallableBond::blackVolQuote_" ref="ac7fc97ae23751dbabc88ac9a0864993f" args="" -->
<a class="el" href="class_quant_lib_1_1_relinkable_handle.html">RelinkableHandle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond.html#ac7fc97ae23751dbabc88ac9a0864993f">blackVolQuote_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Black fwd yield volatility quote handle to internal blackEngine_. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9385551a40b25ffe62098dab0fe5e4eb"></a><!-- doxytag: member="QuantLib::CallableBond::blackDiscountCurve_" ref="a9385551a40b25ffe62098dab0fe5e4eb" args="" -->
<a class="el" href="class_quant_lib_1_1_relinkable_handle.html">RelinkableHandle</a><br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_callable_bond.html#a9385551a40b25ffe62098dab0fe5e4eb">blackDiscountCurve_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Black fwd yield volatility quote handle to internal blackEngine_. <br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae63057c21db39b3ce3afb6fec57f82d0"></a><!-- doxytag: member="QuantLib::CallableBond::ImpliedVolHelper" ref="ae63057c21db39b3ce3afb6fec57f82d0" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ImpliedVolHelper</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Callable bond base class. </p>
<p>Base callable bond class for fixed and zero coupon bonds. Defines commonalities between fixed and zero coupon callable bonds. At present, only European and Bermudan put/call schedules supported (no American optionality), as defined by the <a class="el" href="class_quant_lib_1_1_callability.html" title="instrument callability">Callability</a> class.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Possible enhancements:</a></b></dt><dd><p class="startdd">models/shortrate/calibrationHelpers </p>
<p>OAS/OAD </p>
<p class="enddd">floating rate callable bonds ?</p>
</dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adf862ef9600f7281d63d2d71b9d6a009"></a><!-- doxytag: member="QuantLib::CallableBond::impliedVolatility" ref="adf862ef9600f7281d63d2d71b9d6a009" args="(Real targetValue, const Handle< YieldTermStructure > &discountCurve, Real accuracy, Size maxEvaluations, Volatility minVol, Volatility maxVol) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> <a class="el" href="class_quant_lib_1_1_callable_bond.html#adf862ef9600f7281d63d2d71b9d6a009">impliedVolatility</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"><em>targetValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > & </td>
<td class="paramname"><em>discountCurve</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"><em>accuracy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> </td>
<td class="paramname"><em>maxEvaluations</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td>
<td class="paramname"><em>minVol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gaaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a> </td>
<td class="paramname"><em>maxVol</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the Black implied forward yield volatility </p>
<p>the forward yield volatility, see Hull, Fourth Edition, Chapter 20, pg 536). Relevant only to European put/call schedules </p>
</div>
</div>
<a class="anchor" id="a71e3006b83c8b484bc57296fe94bf36d"></a><!-- doxytag: member="QuantLib::CallableBond::setupArguments" ref="a71e3006b83c8b484bc57296fe94bf36d" args="(PricingEngine::arguments *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="class_quant_lib_1_1_callable_bond.html#a71e3006b83c8b484bc57296fe94bf36d">setupArguments</a> </td>
<td>(</td>
<td class="paramtype">PricingEngine::arguments * </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used. </p>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_bond.html#aad6958108bfaef12bc4ccd6b3d7a7231">Bond</a>.</p>
<p>Reimplemented in <a class="el" href="class_quant_lib_1_1_callable_fixed_rate_bond.html#af6f2357affd0584e0db188a557bdef03">CallableFixedRateBond</a>.</p>
</div>
</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>
|
