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
|
<!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>ZeroInflationIndex 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_zero_inflation_index.html">ZeroInflationIndex</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ZeroInflationIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ZeroInflationIndex" --><!-- doxytag: inherits="QuantLib::InflationIndex" -->
<p>Base class for zero inflation indices.
<a href="class_quant_lib_1_1_zero_inflation_index.html#details">More...</a></p>
<p><code>#include <ql/indexes/inflationindex.hpp></code></p>
<div class="dynheader">
Inheritance diagram for ZeroInflationIndex:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_zero_inflation_index__inherit__graph.png" border="0" usemap="#_zero_inflation_index_inherit__map" alt="Inheritance graph"/></div>
<map name="_zero_inflation_index_inherit__map" id="_zero_inflation_index_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_a_u_c_p_i.html" title="AU CPI index (either quarterly or annual)" alt="" coords="5,166,67,197"/><area shape="rect" id="node7" href="class_quant_lib_1_1_e_u_h_i_c_p.html" title="EU HICP index." alt="" coords="91,166,160,197"/><area shape="rect" id="node9" href="class_quant_lib_1_1_e_u_h_i_c_p_x_t.html" title="EU HICPXT index." alt="" coords="184,166,269,197"/><area shape="rect" id="node11" href="class_quant_lib_1_1_f_r_h_i_c_p.html" title="FR HICP index." alt="" coords="293,166,363,197"/><area shape="rect" id="node13" href="class_quant_lib_1_1_generic_c_p_i.html" title="Generic CPI index." alt="" coords="387,166,475,197"/><area shape="rect" id="node15" href="class_quant_lib_1_1_u_k_r_p_i.html" title="UK Retail Price Inflation Index." alt="" coords="499,166,560,197"/><area shape="rect" id="node17" href="class_quant_lib_1_1_u_s_c_p_i.html" title="US CPI index." alt="" coords="584,166,645,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_inflation_index.html" title="Base class for inflation-rate indexes,." alt="" coords="279,6,377,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_zero_inflation_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="a405cafaa1c2d2ba680a5ef10bc818dd6"></a><!-- doxytag: member="QuantLib::ZeroInflationIndex::ZeroInflationIndex" ref="a405cafaa1c2d2ba680a5ef10bc818dd6" args="(const std::string &familyName, const Region &region, bool revised, bool interpolated, Frequency frequency, const Period &availabilityLag, const Currency &currency, const Handle< ZeroInflationTermStructure > &ts=Handle< ZeroInflationTermStructure >())" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_zero_inflation_index.html#a405cafaa1c2d2ba680a5ef10bc818dd6">ZeroInflationIndex</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#a40c4f14701638cfb8f7ce2ce9cbeabf3">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> &<a class="el" href="class_quant_lib_1_1_inflation_index.html#a1a96e907a4fa3ef48090f8febb6ef80e">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_zero_inflation_term_structure.html">ZeroInflationTermStructure</a> > &ts=<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_zero_inflation_term_structure.html">ZeroInflationTermStructure</a> >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Always use the evaluation date as the reference date. <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Index interface</div></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_zero_inflation_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 colspan="2"><div class="groupHeader">Other methods</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e111b7f22a3b4a568736631d743a296"></a><!-- doxytag: member="QuantLib::ZeroInflationIndex::zeroInflationTermStructure" ref="a6e111b7f22a3b4a568736631d743a296" args="() const " -->
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a><br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_zero_inflation_term_structure.html">ZeroInflationTermStructure</a> > </td><td class="memItemRight" valign="bottom"><b>zeroInflationTermStructure</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07e5121e8d142b09d0810142e07d6107"></a><!-- doxytag: member="QuantLib::ZeroInflationIndex::clone" ref="a07e5121e8d142b09d0810142e07d6107" args="(const Handle< ZeroInflationTermStructure > &h) const " -->
boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_zero_inflation_index.html">ZeroInflationIndex</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_zero_inflation_term_structure.html">ZeroInflationTermStructure</a> > &h) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for zero inflation indices. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1c776ca10de744b29a4d051102003eb9"></a><!-- doxytag: member="QuantLib::ZeroInflationIndex::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_zero_inflation_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">
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000041">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 -->
</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>
|
