File: class_quant_lib_1_1_inflation_index.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 (332 lines) | stat: -rw-r--r-- 21,567 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
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<!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: InflationIndex 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_inflation_index.html">InflationIndex</a></div>
<h1>InflationIndex Class Reference</h1><!-- doxytag: class="QuantLib::InflationIndex" --><!-- doxytag: inherits="QuantLib::Index,QuantLib::Observer" --><code>#include &lt;ql/indexes/inflationindex.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for InflationIndex:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_inflation_index__inherit__graph.png" border="0" usemap="#_inflation_index__inherit__map" alt="Inheritance graph"></center>
<map name="_inflation_index__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_yo_y_inflation_index.html" title="Base class for year&#45;on&#45;year inflation indices." alt="" coords="5,161,139,188"><area shape="rect" href="class_quant_lib_1_1_zero_inflation_index.html" title="Base class for zero inflation indices." alt="" coords="163,161,301,188"><area shape="rect" href="class_quant_lib_1_1_index.html" title="purely virtual base class for indexes" alt="" coords="79,7,135,33"><area shape="rect" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="159,7,239,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_inflation_index-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for inflation-rate indexes,. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="08a953a7e2c9faae6d595913aae0893b"></a><!-- doxytag: member="QuantLib::InflationIndex::InflationIndex" ref="08a953a7e2c9faae6d595913aae0893b" args="(const std::string &amp;familyName, const Region &amp;region, bool revised, bool interpolated, Frequency frequency, const Period &amp;availabilitiyLag, const Currency &amp;currency)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>InflationIndex</b> (const std::string &amp;familyName, const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;region, bool revised, bool interpolated, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;availabilitiyLag, const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> &amp;currency)</td></tr>

<tr><td colspan="2"><div class="groupHeader">Index interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the index.  <a href="#37627d5d5bba7f4a8690c71c2ab3cb07"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#bd47d61ed23fb73440b0c02534236330">fixingCalendar</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a279f27f1bb152aa71ff980f0bae2727"></a><!-- doxytag: member="QuantLib::InflationIndex::isValidFixingDate" ref="a279f27f1bb152aa71ff980f0bae2727" args="(const Date &amp;fixingDate) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#a279f27f1bb152aa71ff980f0bae2727">isValidFixingDate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;fixingDate) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns TRUE if the fixing date is a valid one <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#815d0c772e8124096a2a6bad10638c8a">fixing</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;fixingDate, bool forecastTodaysFixing=false) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#a8992ffa6a24397eda41c2a7ac458c97">addFixing</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;fixingDate, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> fixing, bool forceOverwrite=false)</td></tr>

<tr><td colspan="2"><div class="groupHeader">Observer interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="270dc2fcae13173748f2f3edddd92727"></a><!-- doxytag: member="QuantLib::InflationIndex::familyName" ref="270dc2fcae13173748f2f3edddd92727" args="() const " -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>familyName</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="304741bfa4f39cb526cb58694ba21b72"></a><!-- doxytag: member="QuantLib::InflationIndex::region" ref="304741bfa4f39cb526cb58694ba21b72" args="() const " -->
<a class="el" href="class_quant_lib_1_1_region.html">Region</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>region</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55fadd1d6444ec9683aef9abcf28f0c8"></a><!-- doxytag: member="QuantLib::InflationIndex::revised" ref="55fadd1d6444ec9683aef9abcf28f0c8" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>revised</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#40c4f14701638cfb8f7ce2ce9cbeabf3">interpolated</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70fafd3d3f212d824101e977784dbcf5"></a><!-- doxytag: member="QuantLib::InflationIndex::frequency" ref="70fafd3d3f212d824101e977784dbcf5" args="() const " -->
<a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>frequency</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_period.html">Period</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#1a96e907a4fa3ef48090f8febb6ef80e">availabilityLag</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f41171847c0cf98154d62bb7f71f3070"></a><!-- doxytag: member="QuantLib::InflationIndex::currency" ref="f41171847c0cf98154d62bb7f71f3070" args="() const " -->
<a class="el" href="class_quant_lib_1_1_currency.html">Currency</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>currency</b> () const </td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e22290961d6b56dce069c1c4fda6386"></a><!-- doxytag: member="QuantLib::InflationIndex::referenceDate_" ref="3e22290961d6b56dce069c1c4fda6386" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>referenceDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cabfc12151f5d68c514dcea66310b07b"></a><!-- doxytag: member="QuantLib::InflationIndex::familyName_" ref="cabfc12151f5d68c514dcea66310b07b" args="" -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>familyName_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e317ee96b7d55086990324e05fe08b8d"></a><!-- doxytag: member="QuantLib::InflationIndex::region_" ref="e317ee96b7d55086990324e05fe08b8d" args="" -->
<a class="el" href="class_quant_lib_1_1_region.html">Region</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>region_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2fa7e8f9bd566705c7e223c70a18bc3"></a><!-- doxytag: member="QuantLib::InflationIndex::revised_" ref="f2fa7e8f9bd566705c7e223c70a18bc3" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>revised_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a2ae12e77e0ac75d12813f693958b4a"></a><!-- doxytag: member="QuantLib::InflationIndex::interpolated_" ref="2a2ae12e77e0ac75d12813f693958b4a" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>interpolated_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e358763dc753768bb42e898365204a9a"></a><!-- doxytag: member="QuantLib::InflationIndex::frequency_" ref="e358763dc753768bb42e898365204a9a" args="" -->
<a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>frequency_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56ed474676ed281c13e46b111268048a"></a><!-- doxytag: member="QuantLib::InflationIndex::availabilityLag_" ref="56ed474676ed281c13e46b111268048a" args="" -->
<a class="el" href="class_quant_lib_1_1_period.html">Period</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>availabilityLag_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b8209f252ea1344d7fa6de58bc1102a"></a><!-- doxytag: member="QuantLib::InflationIndex::currency_" ref="9b8209f252ea1344d7fa6de58bc1102a" args="" -->
<a class="el" href="class_quant_lib_1_1_currency.html">Currency</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>currency_</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="37627d5d5bba7f4a8690c71c2ab3cb07"></a><!-- doxytag: member="QuantLib::InflationIndex::name" ref="37627d5d5bba7f4a8690c71c2ab3cb07" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string name           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the name of the index. 
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000013">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#7f04e718c6856c4d3d77a496b6acad0d">Index</a>.</p>

</div>
</div><p>
<a class="anchor" name="bd47d61ed23fb73440b0c02534236330"></a><!-- doxytag: member="QuantLib::InflationIndex::fixingCalendar" ref="bd47d61ed23fb73440b0c02534236330" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> fixingCalendar           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Inflation indices do not have fixing calendars. An inflation index value is valid for every day (including weekends) of a calendar period. I.e. it uses the <a class="el" href="class_quant_lib_1_1_null_calendar.html" title="Calendar for reproducing theoretical calculations.">NullCalendar</a> as its fixing calendar. 
<p>Implements <a class="el" href="class_quant_lib_1_1_index.html#017c78ebe125418dde1aacb7c610265a">Index</a>.</p>

</div>
</div><p>
<a class="anchor" name="815d0c772e8124096a2a6bad10638c8a"></a><!-- doxytag: member="QuantLib::InflationIndex::fixing" ref="815d0c772e8124096a2a6bad10638c8a" args="(const Date &amp;fixingDate, bool forecastTodaysFixing=false) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> fixing           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>fixingDate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>forecastTodaysFixing</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Forecasting index values requires an inflation term structure. The inflation term structure (ITS) defines the usual lag (not the index). I.e. an ITS is always relatve to a base date that is earlier than its asof date. This must be so because indices are available only with a lag. However, the index availability lag only sets a minimum lag for the ITS. An ITS may be relative to an earlier date, e.g. an index may have a 2-month delay in publication but the inflation swaps may take as their base the index 3 months before. 
<p>Implements <a class="el" href="class_quant_lib_1_1_index.html#3fe8532d0a96ae0ba25ac781e150aa37">Index</a>.</p>

<p>Implemented in <a class="el" href="class_quant_lib_1_1_zero_inflation_index.html#1c776ca10de744b29a4d051102003eb9">ZeroInflationIndex</a>, and <a class="el" href="class_quant_lib_1_1_yo_y_inflation_index.html#1c776ca10de744b29a4d051102003eb9">YoYInflationIndex</a>.</p>

</div>
</div><p>
<a class="anchor" name="a8992ffa6a24397eda41c2a7ac458c97"></a><!-- doxytag: member="QuantLib::InflationIndex::addFixing" ref="a8992ffa6a24397eda41c2a7ac458c97" args="(const Date &amp;fixingDate, Rate fixing, bool forceOverwrite=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void addFixing           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>fixingDate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td>
          <td class="paramname"> <em>fixing</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>forceOverwrite</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
this method creates all the "fixings" for the relevant period of the index. E.g. for monthly indices it will put the same value in every calendar day in the month. 
</div>
</div><p>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::InflationIndex::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void update           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><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>Implements <a class="el" href="class_quant_lib_1_1_observer.html#99b02345a8a15d3c5ea2844a2253f510">Observer</a>.</p>

</div>
</div><p>
<a class="anchor" name="40c4f14701638cfb8f7ce2ce9cbeabf3"></a><!-- doxytag: member="QuantLib::InflationIndex::interpolated" ref="40c4f14701638cfb8f7ce2ce9cbeabf3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool interpolated           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Forecasting index values using an inflation term structure uses the interpolation of the inflation term structure unless interpolation is set to false. In this case the extrapolated values are constant within each period taking the mid-period extrapolated value. 
</div>
</div><p>
<a class="anchor" name="1a96e907a4fa3ef48090f8febb6ef80e"></a><!-- doxytag: member="QuantLib::InflationIndex::availabilityLag" ref="1a96e907a4fa3ef48090f8febb6ef80e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_quant_lib_1_1_period.html">Period</a> availabilityLag           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The availability lag describes when the index is <em>available</em>, not how it is used. Specifically the fixing for, say, January, may only be available in April but the index will always return the index value applicable for January as its January fixing (independent of the lag in availability). 
</div>
</div><p>

</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>