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
238
239
240
241
|
<!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>InterestRateIndex 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_interest_rate_index.html">InterestRateIndex</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">InterestRateIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::InterestRateIndex" --><!-- doxytag: inherits="QuantLib::Index,QuantLib::Observer" -->
<p>base class for interest rate indexes
<a href="class_quant_lib_1_1_interest_rate_index.html#details">More...</a></p>
<p><code>#include <ql/indexes/interestrateindex.hpp></code></p>
<div class="dynheader">
Inheritance diagram for InterestRateIndex:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_interest_rate_index__inherit__graph.png" border="0" usemap="#_interest_rate_index_inherit__map" alt="Inheritance graph"/></div>
<map name="_interest_rate_index_inherit__map" id="_interest_rate_index_inherit__map">
<area shape="rect" id="node7" href="class_quant_lib_1_1_b_m_a_index.html" title="Bond Market Association index." alt="" coords="5,166,88,197"/><area shape="rect" id="node9" href="class_quant_lib_1_1_ibor_index.html" title="base class for Inter-Bank-Offered-Rate indexes (e.g. Libor, etc.)" alt="" coords="112,166,187,197"/><area shape="rect" id="node11" href="class_quant_lib_1_1_swap_index.html" title="base class for swap-rate indexes" alt="" coords="211,166,296,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_index.html" title="purely virtual base class for indexes" alt="" coords="79,6,132,37"/><area shape="rect" id="node4" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="156,6,231,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_interest_rate_index-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="aeb7d1f996a04d11f4ac16b353657e930"></a><!-- doxytag: member="QuantLib::InterestRateIndex::InterestRateIndex" ref="aeb7d1f996a04d11f4ac16b353657e930" args="(const std::string &familyName, const Period &tenor, Natural settlementDays, const Currency &currency, const Calendar &fixingCalendar, const DayCounter &dayCounter)" -->
 </td><td class="memItemRight" valign="bottom"><b>InterestRateIndex</b> (const std::string &familyName, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &tenor, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> &currency, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &<a class="el" href="class_quant_lib_1_1_interest_rate_index.html#abd47d61ed23fb73440b0c02534236330">fixingCalendar</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Index interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate_index.html#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the index. <a href="#a37627d5d5bba7f4a8690c71c2ab3cb07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd47d61ed23fb73440b0c02534236330"></a><!-- doxytag: member="QuantLib::InterestRateIndex::fixingCalendar" ref="abd47d61ed23fb73440b0c02534236330" args="() const " -->
<a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate_index.html#abd47d61ed23fb73440b0c02534236330">fixingCalendar</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the calendar defining valid fixing dates <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa279f27f1bb152aa71ff980f0bae2727"></a><!-- doxytag: member="QuantLib::InterestRateIndex::isValidFixingDate" ref="aa279f27f1bb152aa71ff980f0bae2727" args="(const Date &fixingDate) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate_index.html#aa279f27f1bb152aa71ff980f0bae2727">isValidFixingDate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns TRUE if the fixing date is a valid one <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate_index.html#a1c776ca10de744b29a4d051102003eb9">fixing</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate, bool forecastTodaysFixing=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the fixing at the given date <a href="#a1c776ca10de744b29a4d051102003eb9"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Observer interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate_index.html#ac5c54df7ed3b930268c8d7752c101725">update</a> ()</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="a270dc2fcae13173748f2f3edddd92727"></a><!-- doxytag: member="QuantLib::InterestRateIndex::familyName" ref="a270dc2fcae13173748f2f3edddd92727" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><b>familyName</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa71982300427118fd251ac6bb7fa89da"></a><!-- doxytag: member="QuantLib::InterestRateIndex::tenor" ref="aa71982300427118fd251ac6bb7fa89da" args="() const " -->
<a class="el" href="class_quant_lib_1_1_period.html">Period</a> </td><td class="memItemRight" valign="bottom"><b>tenor</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a525a1bb58e63aa211a97c570b1aafc72"></a><!-- doxytag: member="QuantLib::InterestRateIndex::fixingDays" ref="a525a1bb58e63aa211a97c570b1aafc72" args="() const " -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> </td><td class="memItemRight" valign="bottom"><b>fixingDays</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9bc5cf19c2ae0701adf3cccbfb7f514"></a><!-- doxytag: member="QuantLib::InterestRateIndex::fixingDate" ref="ae9bc5cf19c2ae0701adf3cccbfb7f514" args="(const Date &valueDate) const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>fixingDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &valueDate) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc33baebf744532876f39f22cf971342"></a><!-- doxytag: member="QuantLib::InterestRateIndex::currency" ref="abc33baebf744532876f39f22cf971342" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> & </td><td class="memItemRight" valign="bottom"><b>currency</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a677cd8177f9f43a90321e2a7cea44b00"></a><!-- doxytag: member="QuantLib::InterestRateIndex::dayCounter" ref="a677cd8177f9f43a90321e2a7cea44b00" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td><td class="memItemRight" valign="bottom"><b>dayCounter</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Date calculations</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These method can be overridden to implement particular conventions (e.g. EurLibor) </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01fafdb3585a34706678b12af90b1cf9"></a><!-- doxytag: member="QuantLib::InterestRateIndex::valueDate" ref="a01fafdb3585a34706678b12af90b1cf9" args="(const Date &fixingDate) const " -->
virtual <a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>valueDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a272504b2735ffa618889e575d93212a9"></a><!-- doxytag: member="QuantLib::InterestRateIndex::maturityDate" ref="a272504b2735ffa618889e575d93212a9" args="(const Date &valueDate) const =0" -->
virtual <a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>maturityDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &valueDate) const =0</td></tr>
<tr><td colspan="2"><div class="groupHeader">Fixing calculations</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a068334de0e963b4134d832cf035b3e03"></a><!-- doxytag: member="QuantLib::InterestRateIndex::forecastFixing" ref="a068334de0e963b4134d832cf035b3e03" args="(const Date &fixingDate) const =0" -->
virtual <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate_index.html#a068334de0e963b4134d832cf035b3e03">forecastFixing</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">It can be overridden to implement particular conventions. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c8876b15f54345f4c91f930498ad4bf"></a><!-- doxytag: member="QuantLib::InterestRateIndex::pastFixing" ref="a8c8876b15f54345f4c91f930498ad4bf" args="(const Date &fixingDate) const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><b>pastFixing</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate) const </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="acabfc12151f5d68c514dcea66310b07b"></a><!-- doxytag: member="QuantLib::InterestRateIndex::familyName_" ref="acabfc12151f5d68c514dcea66310b07b" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><b>familyName_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f1e4aec3cba6f7cea92368273728ec8"></a><!-- doxytag: member="QuantLib::InterestRateIndex::tenor_" ref="a6f1e4aec3cba6f7cea92368273728ec8" args="" -->
<a class="el" href="class_quant_lib_1_1_period.html">Period</a> </td><td class="memItemRight" valign="bottom"><b>tenor_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b5758dc357368c9bcb7920c66084351"></a><!-- doxytag: member="QuantLib::InterestRateIndex::fixingDays_" ref="a7b5758dc357368c9bcb7920c66084351" args="" -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> </td><td class="memItemRight" valign="bottom"><b>fixingDays_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b8209f252ea1344d7fa6de58bc1102a"></a><!-- doxytag: member="QuantLib::InterestRateIndex::currency_" ref="a9b8209f252ea1344d7fa6de58bc1102a" args="" -->
<a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> </td><td class="memItemRight" valign="bottom"><b>currency_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76c6c2d60ef1370e20bdf40a0e0ca642"></a><!-- doxytag: member="QuantLib::InterestRateIndex::dayCounter_" ref="a76c6c2d60ef1370e20bdf40a0e0ca642" args="" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> </td><td class="memItemRight" valign="bottom"><b>dayCounter_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>base class for interest rate indexes </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000019">Possible enhancements:</a></b></dt><dd>add methods returning <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a37627d5d5bba7f4a8690c71c2ab3cb07"></a><!-- doxytag: member="QuantLib::InterestRateIndex::name" ref="a37627d5d5bba7f4a8690c71c2ab3cb07" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="class_quant_lib_1_1_interest_rate_index.html#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the index. </p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000031">Warning:</a></b></dt><dd>This method is used for output and comparison between indexes. It is <b>not</b> meant to be used for writing switch-on-type code. </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_index.html#a7f04e718c6856c4d3d77a496b6acad0d">Index</a>.</p>
<p>Reimplemented in <a class="el" href="class_quant_lib_1_1_b_m_a_index.html#a37627d5d5bba7f4a8690c71c2ab3cb07">BMAIndex</a>.</p>
</div>
</div>
<a class="anchor" id="a1c776ca10de744b29a4d051102003eb9"></a><!-- doxytag: member="QuantLib::InterestRateIndex::fixing" ref="a1c776ca10de744b29a4d051102003eb9" args="(const Date &fixingDate, bool forecastTodaysFixing=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> <a class="el" href="class_quant_lib_1_1_interest_rate_index.html#a1c776ca10de744b29a4d051102003eb9">fixing</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>fixingDate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>forecastTodaysFixing</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the fixing at the given date </p>
<p>the date passed as arguments must be the actual calendar date of the fixing; no settlement days must be used. </p>
<p>Implements <a class="el" href="class_quant_lib_1_1_index.html#a3fe8532d0a96ae0ba25ac781e150aa37">Index</a>.</p>
</div>
</div>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::InterestRateIndex::update" ref="ac5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_quant_lib_1_1_interest_rate_index.html#ac5c54df7ed3b930268c8d7752c101725">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes. </p>
<p>Implements <a class="el" href="class_quant_lib_1_1_observer.html#a99b02345a8a15d3c5ea2844a2253f510">Observer</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>
|
