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
|
<!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>CPICashFlow 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_c_p_i_cash_flow.html">CPICashFlow</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">CPICashFlow Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::CPICashFlow" --><!-- doxytag: inherits="QuantLib::IndexedCashFlow" -->
<p>Cash flow paying the performance of a CPI (zero inflation) index.
<a href="class_quant_lib_1_1_c_p_i_cash_flow.html#details">More...</a></p>
<p><code>#include <ql/cashflows/cpicoupon.hpp></code></p>
<div class="dynheader">
Inheritance diagram for CPICashFlow:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_c_p_i_cash_flow__inherit__graph.png" border="0" usemap="#_c_p_i_cash_flow_inherit__map" alt="Inheritance graph"/></div>
<map name="_c_p_i_cash_flow_inherit__map" id="_c_p_i_cash_flow_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_indexed_cash_flow.html" title="Cash flow dependent on an index ratio." alt="" coords="5,6,131,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_c_p_i_cash_flow-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="a5d51a9777b4b4f18d4007f25091d25f2"></a><!-- doxytag: member="QuantLib::CPICashFlow::CPICashFlow" ref="a5d51a9777b4b4f18d4007f25091d25f2" args="(Real notional, const boost::shared_ptr< ZeroInflationIndex > &index, const Date &baseDate, Real baseFixing, const Date &fixingDate, const Date &paymentDate, bool growthOnly=false, CPI::InterpolationType interpolation=CPI::AsIndex, const Frequency &frequency=QuantLib::NoFrequency)" -->
 </td><td class="memItemRight" valign="bottom"><b>CPICashFlow</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> notional, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_zero_inflation_index.html">ZeroInflationIndex</a> > &index, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &<a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a89ce98e9bb2a22127b03621ee6149660">baseDate</a>, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a3734ff74e8dac1f6d7c475d16bb6e305">baseFixing</a>, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &fixingDate, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &paymentDate, bool growthOnly=false, CPI::InterpolationType <a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a6fbb6ffa487bc0df2258f120de8ad1ca">interpolation</a>=CPI::AsIndex, const <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> &frequency=QuantLib::NoFrequency)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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_c_p_i_cash_flow.html#a3734ff74e8dac1f6d7c475d16bb6e305">baseFixing</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">value used on base date <a href="#a3734ff74e8dac1f6d7c475d16bb6e305"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89ce98e9bb2a22127b03621ee6149660"></a><!-- doxytag: member="QuantLib::CPICashFlow::baseDate" ref="a89ce98e9bb2a22127b03621ee6149660" args="() const " -->
virtual <a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a89ce98e9bb2a22127b03621ee6149660">baseDate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">you may not have a valid date <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fbb6ffa487bc0df2258f120de8ad1ca"></a><!-- doxytag: member="QuantLib::CPICashFlow::interpolation" ref="a6fbb6ffa487bc0df2258f120de8ad1ca" args="() const " -->
virtual CPI::InterpolationType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a6fbb6ffa487bc0df2258f120de8ad1ca">interpolation</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">do you want linear/constant/as-index interpolation of future data? <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d031749634662c6fd7dd3679f26a487"></a><!-- doxytag: member="QuantLib::CPICashFlow::frequency" ref="a2d031749634662c6fd7dd3679f26a487" args="() const " -->
virtual <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td><td class="memItemRight" valign="bottom"><b>frequency</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16b8c27249065cfd9c5a2df99c217fac"></a><!-- doxytag: member="QuantLib::CPICashFlow::amount" ref="a16b8c27249065cfd9c5a2df99c217fac" args="() const " -->
virtual <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_c_p_i_cash_flow.html#a16b8c27249065cfd9c5a2df99c217fac">amount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">redefined to use <a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a3734ff74e8dac1f6d7c475d16bb6e305" title="value used on base date">baseFixing()</a> and interpolation <br/></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="ad18000721e8a3c1b8ef1f02ec339db06"></a><!-- doxytag: member="QuantLib::CPICashFlow::baseFixing_" ref="ad18000721e8a3c1b8ef1f02ec339db06" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>baseFixing_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f2dce5ac68bbcdca60a224ec80448aa"></a><!-- doxytag: member="QuantLib::CPICashFlow::interpolation_" ref="a4f2dce5ac68bbcdca60a224ec80448aa" args="" -->
CPI::InterpolationType </td><td class="memItemRight" valign="bottom"><b>interpolation_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae358763dc753768bb42e898365204a9a"></a><!-- doxytag: member="QuantLib::CPICashFlow::frequency_" ref="ae358763dc753768bb42e898365204a9a" args="" -->
<a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td><td class="memItemRight" valign="bottom"><b>frequency_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Cash flow paying the performance of a CPI (zero inflation) index. </p>
<p>It is NOT a coupon, i.e. no accruals. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3734ff74e8dac1f6d7c475d16bb6e305"></a><!-- doxytag: member="QuantLib::CPICashFlow::baseFixing" ref="a3734ff74e8dac1f6d7c475d16bb6e305" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a3734ff74e8dac1f6d7c475d16bb6e305">baseFixing</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>value used on base date </p>
<p>This does not have to agree with index on that date. </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>
|
