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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: YoYInflationIndex Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://quantlib.org">
<img alt="QuantLib" src="QL-title.jpg"></a>
<div id="projectbrief">A free/open-source library for quantitative finance</div>
<div id="projectnumber">Reference manual - version 1.20</div>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_yo_y_inflation_index.html">YoYInflationIndex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_quant_lib_1_1_yo_y_inflation_index-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">YoYInflationIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for year-on-year inflation indices.
<a href="class_quant_lib_1_1_yo_y_inflation_index.html#details">More...</a></p>
<p><code>#include <ql/indexes/inflationindex.hpp></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for YoYInflationIndex:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_quant_lib_1_1_yo_y_inflation_index__inherit__graph.png" border="0" usemap="#a_yo_y_inflation_index_inherit__map" alt="Inheritance graph"/></div>
<map name="_yo_y_inflation_index_inherit__map" id="a_yo_y_inflation_index_inherit__map">
<area shape="rect" title="Base class for year-on-year inflation indices." alt="" coords="276,360,400,387"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_a_u_c_p_i.html" title="Genuine year-on-year AU CPI (i.e. not a ratio)" alt="" coords="464,5,544,32"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_a_u_c_p_ir.html" title="Fake year-on-year AUCPI (i.e. a ratio)" alt="" coords="462,56,546,83"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_e_u_h_i_c_p.html" title="Genuine year-on-year EU HICP (i.e. not a ratio of EU HICP)" alt="" coords="458,107,550,133"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_e_u_h_i_c_pr.html" title="Fake year-on-year EU HICP (i.e. a ratio of EU HICP)" alt="" coords="456,157,552,184"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_e_u_h_i_c_p_x_t.html" title="Genuine year-on-year EU HICPXT." alt="" coords="449,208,559,235"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_f_r_h_i_c_p.html" title="Genuine year-on-year FR HICP (i.e. not a ratio)" alt="" coords="459,259,549,285"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_f_r_h_i_c_pr.html" title="Fake year-on-year FR HICP (i.e. a ratio)" alt="" coords="457,309,551,336"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_generic_c_p_i.html" title="Genuine year-on-year Generic CPI (i.e. not a ratio)" alt="" coords="450,360,558,387"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_generic_c_p_ir.html" title="Fake year-on-year GenericCPI (i.e. a ratio)" alt="" coords="448,411,560,437"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_u_k_r_p_i.html" title="Genuine year-on-year UK RPI (i.e. not a ratio of UK RPI)" alt="" coords="463,461,545,488"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_u_k_r_p_ir.html" title="Fake year-on-year UK RPI (i.e. a ratio of UK RPI)" alt="" coords="461,512,547,539"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_u_s_c_p_i.html" title="Genuine year-on-year US CPI (i.e. not a ratio of US CPI)" alt="" coords="463,563,545,589"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_u_s_c_p_ir.html" title="Fake year-on-year US CPI (i.e. a ratio of US CPI)" alt="" coords="461,613,547,640"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_z_a_c_p_i.html" title="Genuine year-on-year South African CPI (i.e. not a ratio of ZA CPI)" alt="" coords="464,664,544,691"/>
<area shape="rect" href="class_quant_lib_1_1_y_y_z_a_c_p_ir.html" title="Fake year-on-year South African CPI (i.e. a ratio of ZA CPI)" alt="" coords="462,715,546,741"/>
<area shape="rect" href="class_quant_lib_1_1_inflation_index.html" title="Base class for inflation-rate indexes,." alt="" coords="128,360,228,387"/>
<area shape="rect" href="class_quant_lib_1_1_index.html" title="purely virtual base class for indexes" alt="" coords="15,335,70,361"/>
<area shape="rect" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="5,385,80,412"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9c8e75da8b8f15185f87c2ec73388af3"><td class="memItemLeft" align="right" valign="top"><a id="a9c8e75da8b8f15185f87c2ec73388af3"></a>
 </td><td class="memItemRight" valign="bottom"><b>YoYInflationIndex</b> (const std::string &familyName, const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &region, bool revised, bool <a class="el" href="class_quant_lib_1_1_inflation_index.html#a387f78c7b46a0e836e1ad668780cd340">interpolated</a>, bool ratio, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &<a class="el" href="class_quant_lib_1_1_inflation_index.html#aee01d8031542a0054a2b5fe5d06bde1c">availabilityLag</a>, 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_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yo_y_inflation_term_structure.html">YoYInflationTermStructure</a> > &ts=<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yo_y_inflation_term_structure.html">YoYInflationTermStructure</a> >())</td></tr>
<tr class="separator:a9c8e75da8b8f15185f87c2ec73388af3"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Index interface</div></td></tr>
<tr class="memitem:a700a136096f8caff21a6244efa074658"><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_yo_y_inflation_index.html#a700a136096f8caff21a6244efa074658">fixing</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate, bool forecastTodaysFixing=false) const</td></tr>
<tr class="separator:a700a136096f8caff21a6244efa074658"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_inflation_index"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_inflation_index')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_inflation_index.html">InflationIndex</a></td></tr>
<tr class="memitem:a08a953a7e2c9faae6d595913aae0893b inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#a08a953a7e2c9faae6d595913aae0893b">InflationIndex</a> (const std::string &familyName, const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &region, bool revised, bool <a class="el" href="class_quant_lib_1_1_inflation_index.html#a387f78c7b46a0e836e1ad668780cd340">interpolated</a>, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &availabilitiyLag, const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> &currency)</td></tr>
<tr class="separator:a08a953a7e2c9faae6d595913aae0893b inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr>
<tr class="memdesc:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the index. <a href="class_quant_lib_1_1_inflation_index.html#a1d89c28bd42ba9a52da008bb69367171">More...</a><br /></td></tr>
<tr class="separator:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50b393670cb5180b20b27beed91eb2bd inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><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_inflation_index.html#a50b393670cb5180b20b27beed91eb2bd">fixingCalendar</a> () const</td></tr>
<tr class="separator:a50b393670cb5180b20b27beed91eb2bd inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9d031d4ae821bcb452fb6441bb2739a inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="ab9d031d4ae821bcb452fb6441bb2739a"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#ab9d031d4ae821bcb452fb6441bb2739a">isValidFixingDate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &) const</td></tr>
<tr class="memdesc:ab9d031d4ae821bcb452fb6441bb2739a inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="mdescLeft"> </td><td class="mdescRight">returns TRUE if the fixing date is a valid one <br /></td></tr>
<tr class="separator:ab9d031d4ae821bcb452fb6441bb2739a inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8992ffa6a24397eda41c2a7ac458c97 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#aa8992ffa6a24397eda41c2a7ac458c97">addFixing</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> <a class="el" href="class_quant_lib_1_1_inflation_index.html#ab2e953a50a4d61d840d72c13c4789ea6">fixing</a>, bool forceOverwrite=false)</td></tr>
<tr class="separator:aa8992ffa6a24397eda41c2a7ac458c97 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5c54df7ed3b930268c8d7752c101725 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#ac5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr class="separator:ac5c54df7ed3b930268c8d7752c101725 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af999e57407e5d904d620d62b593fd9a1 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="af999e57407e5d904d620d62b593fd9a1"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>familyName</b> () const</td></tr>
<tr class="separator:af999e57407e5d904d620d62b593fd9a1 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7c524e779f219dd4474c06e44be9b78 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="af7c524e779f219dd4474c06e44be9b78"></a>
<a class="el" href="class_quant_lib_1_1_region.html">Region</a> </td><td class="memItemRight" valign="bottom"><b>region</b> () const</td></tr>
<tr class="separator:af7c524e779f219dd4474c06e44be9b78 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a362caeefbc106eb8f1101ad46ae9d20d inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="a362caeefbc106eb8f1101ad46ae9d20d"></a>
bool </td><td class="memItemRight" valign="bottom"><b>revised</b> () const</td></tr>
<tr class="separator:a362caeefbc106eb8f1101ad46ae9d20d inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a387f78c7b46a0e836e1ad668780cd340 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#a387f78c7b46a0e836e1ad668780cd340">interpolated</a> () const</td></tr>
<tr class="separator:a387f78c7b46a0e836e1ad668780cd340 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbf0d54ac5dbc652d38513b587cbc100 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="adbf0d54ac5dbc652d38513b587cbc100"></a>
<a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td><td class="memItemRight" valign="bottom"><b>frequency</b> () const</td></tr>
<tr class="separator:adbf0d54ac5dbc652d38513b587cbc100 inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee01d8031542a0054a2b5fe5d06bde1c inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_period.html">Period</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_inflation_index.html#aee01d8031542a0054a2b5fe5d06bde1c">availabilityLag</a> () const</td></tr>
<tr class="separator:aee01d8031542a0054a2b5fe5d06bde1c inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada359925de6dec4db3d8488e64a46fcf inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="ada359925de6dec4db3d8488e64a46fcf"></a>
<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 class="separator:ada359925de6dec4db3d8488e64a46fcf inherit pub_methods_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_index"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_index')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_index.html">Index</a></td></tr>
<tr class="memitem:adb5212d6af227d9d3d251bbf39ba11a6 inherit pub_methods_class_quant_lib_1_1_index"><td class="memItemLeft" align="right" valign="top"><a id="adb5212d6af227d9d3d251bbf39ba11a6"></a>
const <a class="el" href="class_quant_lib_1_1_time_series.html">TimeSeries</a>< <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index.html#adb5212d6af227d9d3d251bbf39ba11a6">timeSeries</a> () const</td></tr>
<tr class="memdesc:adb5212d6af227d9d3d251bbf39ba11a6 inherit pub_methods_class_quant_lib_1_1_index"><td class="mdescLeft"> </td><td class="mdescRight">returns the fixing <a class="el" href="class_quant_lib_1_1_time_series.html" title="Container for historical data.">TimeSeries</a> <br /></td></tr>
<tr class="separator:adb5212d6af227d9d3d251bbf39ba11a6 inherit pub_methods_class_quant_lib_1_1_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d511459f4bbc7cc8598b479d2ac4faf inherit pub_methods_class_quant_lib_1_1_index"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index.html#a4d511459f4bbc7cc8598b479d2ac4faf">allowsNativeFixings</a> ()</td></tr>
<tr class="memdesc:a4d511459f4bbc7cc8598b479d2ac4faf inherit pub_methods_class_quant_lib_1_1_index"><td class="mdescLeft"> </td><td class="mdescRight">check if index allows for native fixings. <a href="class_quant_lib_1_1_index.html#a4d511459f4bbc7cc8598b479d2ac4faf">More...</a><br /></td></tr>
<tr class="separator:a4d511459f4bbc7cc8598b479d2ac4faf inherit pub_methods_class_quant_lib_1_1_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7508199daa86b2f60ad153454b944558 inherit pub_methods_class_quant_lib_1_1_index"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index.html#a7508199daa86b2f60ad153454b944558">addFixings</a> (const <a class="el" href="class_quant_lib_1_1_time_series.html">TimeSeries</a>< <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> > &t, bool forceOverwrite=false)</td></tr>
<tr class="memdesc:a7508199daa86b2f60ad153454b944558 inherit pub_methods_class_quant_lib_1_1_index"><td class="mdescLeft"> </td><td class="mdescRight">stores historical fixings from a <a class="el" href="class_quant_lib_1_1_time_series.html" title="Container for historical data.">TimeSeries</a> <a href="class_quant_lib_1_1_index.html#a7508199daa86b2f60ad153454b944558">More...</a><br /></td></tr>
<tr class="separator:a7508199daa86b2f60ad153454b944558 inherit pub_methods_class_quant_lib_1_1_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5a81c6efaef1986836098611234389a inherit pub_methods_class_quant_lib_1_1_index"><td class="memTemplParams" colspan="2">template<class DateIterator , class ValueIterator > </td></tr>
<tr class="memitem:ac5a81c6efaef1986836098611234389a inherit pub_methods_class_quant_lib_1_1_index"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index.html#ac5a81c6efaef1986836098611234389a">addFixings</a> (DateIterator dBegin, DateIterator dEnd, ValueIterator vBegin, bool forceOverwrite=false)</td></tr>
<tr class="memdesc:ac5a81c6efaef1986836098611234389a inherit pub_methods_class_quant_lib_1_1_index"><td class="mdescLeft"> </td><td class="mdescRight">stores historical fixings at the given dates <a href="class_quant_lib_1_1_index.html#ac5a81c6efaef1986836098611234389a">More...</a><br /></td></tr>
<tr class="separator:ac5a81c6efaef1986836098611234389a inherit pub_methods_class_quant_lib_1_1_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45034f65c461ffc15eb4679b02dde6c1 inherit pub_methods_class_quant_lib_1_1_index"><td class="memItemLeft" align="right" valign="top"><a id="a45034f65c461ffc15eb4679b02dde6c1"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_index.html#a45034f65c461ffc15eb4679b02dde6c1">clearFixings</a> ()</td></tr>
<tr class="memdesc:a45034f65c461ffc15eb4679b02dde6c1 inherit pub_methods_class_quant_lib_1_1_index"><td class="mdescLeft"> </td><td class="mdescRight">clears all stored historical fixings <br /></td></tr>
<tr class="separator:a45034f65c461ffc15eb4679b02dde6c1 inherit pub_methods_class_quant_lib_1_1_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_observable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_observable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a></td></tr>
<tr class="memitem:a840dd96e33a304cbf681d357de7f48d0 inherit pub_methods_class_quant_lib_1_1_observable"><td class="memItemLeft" align="right" valign="top"><a id="a840dd96e33a304cbf681d357de7f48d0"></a>
 </td><td class="memItemRight" valign="bottom"><b>Observable</b> (const <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &)</td></tr>
<tr class="separator:a840dd96e33a304cbf681d357de7f48d0 inherit pub_methods_class_quant_lib_1_1_observable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a522aacdd0f2408fe5e46527a6db999b4 inherit pub_methods_class_quant_lib_1_1_observable"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observable.html#a522aacdd0f2408fe5e46527a6db999b4">operator=</a> (const <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> &)</td></tr>
<tr class="separator:a522aacdd0f2408fe5e46527a6db999b4 inherit pub_methods_class_quant_lib_1_1_observable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a397546715bfc5aedd1d16dd202a19d4c inherit pub_methods_class_quant_lib_1_1_observable"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observable.html#a397546715bfc5aedd1d16dd202a19d4c">notifyObservers</a> ()</td></tr>
<tr class="separator:a397546715bfc5aedd1d16dd202a19d4c inherit pub_methods_class_quant_lib_1_1_observable"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_observer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_observer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_observer.html">Observer</a></td></tr>
<tr class="memitem:af6a9d3ca0b7f388f3b7ccb1eccf11f63 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="af6a9d3ca0b7f388f3b7ccb1eccf11f63"></a>
 </td><td class="memItemRight" valign="bottom"><b>Observer</b> (const <a class="el" href="class_quant_lib_1_1_observer.html">Observer</a> &)</td></tr>
<tr class="separator:af6a9d3ca0b7f388f3b7ccb1eccf11f63 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6810b3645967da11d5f5d4804d37bacc inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="a6810b3645967da11d5f5d4804d37bacc"></a>
<a class="el" href="class_quant_lib_1_1_observer.html">Observer</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="class_quant_lib_1_1_observer.html">Observer</a> &)</td></tr>
<tr class="separator:a6810b3645967da11d5f5d4804d37bacc inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6ade205ed506bf712da2704f80a73a0 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="aa6ade205ed506bf712da2704f80a73a0"></a>
std::pair< iterator, bool > </td><td class="memItemRight" valign="bottom"><b>registerWith</b> (const ext::shared_ptr< <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> > &)</td></tr>
<tr class="separator:aa6ade205ed506bf712da2704f80a73a0 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51d57eb97a3a57312a47bda29235f182 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observer.html#a51d57eb97a3a57312a47bda29235f182">registerWithObservables</a> (const ext::shared_ptr< <a class="el" href="class_quant_lib_1_1_observer.html">Observer</a> > &)</td></tr>
<tr class="separator:a51d57eb97a3a57312a47bda29235f182 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ce7359ad0f73a54dba555be24855804 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="a4ce7359ad0f73a54dba555be24855804"></a>
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>unregisterWith</b> (const ext::shared_ptr< <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> > &)</td></tr>
<tr class="separator:a4ce7359ad0f73a54dba555be24855804 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c19cb502f3b720b99b176ea6cc7e319 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="a0c19cb502f3b720b99b176ea6cc7e319"></a>
void </td><td class="memItemRight" valign="bottom"><b>unregisterWithAll</b> ()</td></tr>
<tr class="separator:a0c19cb502f3b720b99b176ea6cc7e319 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d53f9669c128dadc74a5d044a7c8e68 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_observer.html#a3d53f9669c128dadc74a5d044a7c8e68">deepUpdate</a> ()</td></tr>
<tr class="separator:a3d53f9669c128dadc74a5d044a7c8e68 inherit pub_methods_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Other methods</h2></td></tr>
<tr class="memitem:a6c0aaf043b6ff8d960a29221ed7c25e8"><td class="memItemLeft" align="right" valign="top"><a id="a6c0aaf043b6ff8d960a29221ed7c25e8"></a>
bool </td><td class="memItemRight" valign="bottom"><b>ratio</b> () const</td></tr>
<tr class="separator:a6c0aaf043b6ff8d960a29221ed7c25e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62bf55b683d2d51c956d06fd99d267b2"><td class="memItemLeft" align="right" valign="top"><a id="a62bf55b683d2d51c956d06fd99d267b2"></a>
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yo_y_inflation_term_structure.html">YoYInflationTermStructure</a> > </td><td class="memItemRight" valign="bottom"><b>yoyInflationTermStructure</b> () const</td></tr>
<tr class="separator:a62bf55b683d2d51c956d06fd99d267b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1af444671f54cea5cebf939f68e0dc3"><td class="memItemLeft" align="right" valign="top"><a id="ab1af444671f54cea5cebf939f68e0dc3"></a>
ext::shared_ptr< <a class="el" href="class_quant_lib_1_1_yo_y_inflation_index.html">YoYInflationIndex</a> > </td><td class="memItemRight" valign="bottom"><b>clone</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yo_y_inflation_term_structure.html">YoYInflationTermStructure</a> > &h) const</td></tr>
<tr class="separator:ab1af444671f54cea5cebf939f68e0dc3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_quant_lib_1_1_observer"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_quant_lib_1_1_observer')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_quant_lib_1_1_observer.html">Observer</a></td></tr>
<tr class="memitem:a78de5f2b6bce96d718e3c18b9f52d67c inherit pub_types_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="a78de5f2b6bce96d718e3c18b9f52d67c"></a>
typedef boost::unordered_set< ext::shared_ptr< <a class="el" href="class_quant_lib_1_1_observable.html">Observable</a> > > </td><td class="memItemRight" valign="bottom"><b>set_type</b></td></tr>
<tr class="separator:a78de5f2b6bce96d718e3c18b9f52d67c inherit pub_types_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae98429250f6997df7b87f4b37454609e inherit pub_types_class_quant_lib_1_1_observer"><td class="memItemLeft" align="right" valign="top"><a id="ae98429250f6997df7b87f4b37454609e"></a>
typedef set_type::iterator </td><td class="memItemRight" valign="bottom"><b>iterator</b></td></tr>
<tr class="separator:ae98429250f6997df7b87f4b37454609e inherit pub_types_class_quant_lib_1_1_observer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_class_quant_lib_1_1_inflation_index"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_quant_lib_1_1_inflation_index')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_quant_lib_1_1_inflation_index.html">InflationIndex</a></td></tr>
<tr class="memitem:a3e22290961d6b56dce069c1c4fda6386 inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="a3e22290961d6b56dce069c1c4fda6386"></a>
<a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>referenceDate_</b></td></tr>
<tr class="separator:a3e22290961d6b56dce069c1c4fda6386 inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acabfc12151f5d68c514dcea66310b07b inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="acabfc12151f5d68c514dcea66310b07b"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>familyName_</b></td></tr>
<tr class="separator:acabfc12151f5d68c514dcea66310b07b inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae317ee96b7d55086990324e05fe08b8d inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="ae317ee96b7d55086990324e05fe08b8d"></a>
<a class="el" href="class_quant_lib_1_1_region.html">Region</a> </td><td class="memItemRight" valign="bottom"><b>region_</b></td></tr>
<tr class="separator:ae317ee96b7d55086990324e05fe08b8d inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2fa7e8f9bd566705c7e223c70a18bc3 inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="af2fa7e8f9bd566705c7e223c70a18bc3"></a>
bool </td><td class="memItemRight" valign="bottom"><b>revised_</b></td></tr>
<tr class="separator:af2fa7e8f9bd566705c7e223c70a18bc3 inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a2ae12e77e0ac75d12813f693958b4a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="a2a2ae12e77e0ac75d12813f693958b4a"></a>
bool </td><td class="memItemRight" valign="bottom"><b>interpolated_</b></td></tr>
<tr class="separator:a2a2ae12e77e0ac75d12813f693958b4a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae358763dc753768bb42e898365204a9a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="ae358763dc753768bb42e898365204a9a"></a>
<a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td><td class="memItemRight" valign="bottom"><b>frequency_</b></td></tr>
<tr class="separator:ae358763dc753768bb42e898365204a9a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56ed474676ed281c13e46b111268048a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="a56ed474676ed281c13e46b111268048a"></a>
<a class="el" href="class_quant_lib_1_1_period.html">Period</a> </td><td class="memItemRight" valign="bottom"><b>availabilityLag_</b></td></tr>
<tr class="separator:a56ed474676ed281c13e46b111268048a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b8209f252ea1344d7fa6de58bc1102a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memItemLeft" align="right" valign="top"><a id="a9b8209f252ea1344d7fa6de58bc1102a"></a>
<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 class="separator:a9b8209f252ea1344d7fa6de58bc1102a inherit pro_attribs_class_quant_lib_1_1_inflation_index"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for year-on-year inflation indices. </p>
<p>These may be genuine indices published on, say, Bloomberg, or "fake" indices that are defined as the ratio of an index at different time points. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a700a136096f8caff21a6244efa074658"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a700a136096f8caff21a6244efa074658">◆ </a></span>fixing()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> fixing </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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000053">Warning:</a></b></dt><dd>the forecastTodaysFixing parameter (required by the <a class="el" href="class_quant_lib_1_1_index.html" title="purely virtual base class for indexes">Index</a> interface) is currently ignored. </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_inflation_index.html#ab2e953a50a4d61d840d72c13c4789ea6">InflationIndex</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>
|
