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
|
<!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: YoYInflationIndex 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_yo_y_inflation_index.html">YoYInflationIndex</a></div>
<h1>YoYInflationIndex Class Reference</h1><!-- doxytag: class="QuantLib::YoYInflationIndex" --><!-- doxytag: inherits="QuantLib::InflationIndex" --><code>#include <ql/indexes/inflationindex.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for YoYInflationIndex:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_yo_y_inflation_index__inherit__graph.png" border="0" usemap="#_yo_y_inflation_index__inherit__map" alt="Inheritance graph"></center>
<map name="_yo_y_inflation_index__inherit__map">
<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="5,161,99,188"><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="123,161,221,188"><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="245,161,328,188"><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="352,161,440,188"><area shape="rect" href="class_quant_lib_1_1_inflation_index.html" title="Base class for inflation-rate indexes,." alt="" coords="175,7,284,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_yo_y_inflation_index-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for year-on-year inflation indices.
<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. <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="9c8e75da8b8f15185f87c2ec73388af3"></a><!-- doxytag: member="QuantLib::YoYInflationIndex::YoYInflationIndex" ref="9c8e75da8b8f15185f87c2ec73388af3" args="(const std::string &familyName, const Region &region, bool revised, bool interpolated, bool ratio, Frequency frequency, const Period &availabilityLag, const Currency &currency, const Handle< YoYInflationTermStructure > &ts=Handle< YoYInflationTermStructure >())" -->
</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 interpolated, bool ratio, <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> &availabilityLag, 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><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yo_y_inflation_index.html#1c776ca10de744b29a4d051102003eb9">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="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20c2db4456208bb1ed76d261f476da6c"></a><!-- doxytag: member="QuantLib::YoYInflationIndex::ratio" ref="20c2db4456208bb1ed76d261f476da6c" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>ratio</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f97e6d7efbb42aab3230ab12a16e2b7"></a><!-- doxytag: member="QuantLib::YoYInflationIndex::yoyInflationTermStructure" ref="0f97e6d7efbb42aab3230ab12a16e2b7" args="() 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> > </td><td class="memItemRight" valign="bottom"><b>yoyInflationTermStructure</b> () const </td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1c776ca10de744b29a4d051102003eb9"></a><!-- doxytag: member="QuantLib::YoYInflationIndex::fixing" ref="1c776ca10de744b29a4d051102003eb9" 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#gede435af51236692b1107d7639581d39">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [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_inflation_index.html#815d0c772e8124096a2a6bad10638c8a">InflationIndex</a>.</p>
</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>
|
