File: class_quant_lib_1_1_piecewise_zero_inflation_curve.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (189 lines) | stat: -rw-r--r-- 14,774 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
<!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>PiecewiseZeroInflationCurve&lt; Interpolator, Bootstrap, Traits &gt; Class Template 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_piecewise_zero_inflation_curve.html">PiecewiseZeroInflationCurve</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">PiecewiseZeroInflationCurve&lt; Interpolator, Bootstrap, Traits &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::PiecewiseZeroInflationCurve" --><!-- doxytag: inherits="QuantLib::InterpolatedZeroInflationCurve,QuantLib::LazyObject" -->
<p>Piecewise zero-inflation term structure.  
 <a href="class_quant_lib_1_1_piecewise_zero_inflation_curve.html#details">More...</a></p>

<p><code>#include &lt;ql/termstructures/inflation/piecewisezeroinflationcurve.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PiecewiseZeroInflationCurve&lt; Interpolator, Bootstrap, Traits &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_piecewise_zero_inflation_curve__inherit__graph.png" border="0" usemap="#_piecewise_zero_inflation_curve_3_01_interpolator_00_01_bootstrap_00_01_traits_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_piecewise_zero_inflation_curve_3_01_interpolator_00_01_bootstrap_00_01_traits_01_4_inherit__map" id="_piecewise_zero_inflation_curve_3_01_interpolator_00_01_bootstrap_00_01_traits_01_4_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_interpolated_zero_inflation_curve.html" title="Inflation term structure based on the interpolation of zero rates." alt="" coords="5,6,288,37"/><area shape="rect" id="node4" href="class_quant_lib_1_1_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="312,6,400,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_piecewise_zero_inflation_curve-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aada8c38edc7a4968494c4838ecfd99ce"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::traits_type" ref="aada8c38edc7a4968494c4838ecfd99ce" args="" -->
typedef Traits&#160;</td><td class="memItemRight" valign="bottom"><b>traits_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89a0f20565fc38a4735f79b7c6deeed7"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::interpolator_type" ref="a89a0f20565fc38a4735f79b7c6deeed7" args="" -->
typedef Interpolator&#160;</td><td class="memItemRight" valign="bottom"><b>interpolator_type</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f7ba4e24201b91b39620ec4e2ca80ff"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::PiecewiseZeroInflationCurve" ref="a6f7ba4e24201b91b39620ec4e2ca80ff" args="(const Date &amp;referenceDate, const Calendar &amp;calendar, const DayCounter &amp;dayCounter, const Period &amp;lag, Frequency frequency, bool indexIsInterpolated, Rate baseZeroRate, const Handle&lt; YieldTermStructure &gt; &amp;nominalTS, const std::vector&lt; boost::shared_ptr&lt; typename Traits::helper &gt; &gt; &amp;instruments, Real accuracy=1.0e&#45;12, const Interpolator &amp;i=Interpolator())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>PiecewiseZeroInflationCurve</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#aa9ae6cc6009ac64d4f265065eab08be0">referenceDate</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#ae9a0f3904cff2fe61596c593dd0b6448">calendar</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;lag, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, bool indexIsInterpolated, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> baseZeroRate, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;nominalTS, const std::vector&lt; boost::shared_ptr&lt; typename Traits::helper &gt; &gt; &amp;instruments, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-12, const Interpolator &amp;i=Interpolator())</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inflation interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_zero_inflation_curve.html#a872006051a1b47c481388e2f5313fd91">baseDate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">minimum (base) date  <a href="#a872006051a1b47c481388e2f5313fd91"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::maxDate" ref="a74d8fc5480ca811db8332b7b30597fe9" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_zero_inflation_curve.html#a74d8fc5480ca811db8332b7b30597fe9">maxDate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the latest date for which the curve can return values <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa338cfa77dc3c8dc467f4225459094fd"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::times" ref="aa338cfa77dc3c8dc467f4225459094fd" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>times</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a021de10463e6e18e294494d7cbb2b75d"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::dates" ref="a021de10463e6e18e294494d7cbb2b75d" args="() const " -->
const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>dates</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4cb0310cb2b45d6d243dd93f5d0b00f"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::data" ref="ac4cb0310cb2b45d6d243dd93f5d0b00f" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad18c145fb4f30b90c7f7a93f9b36417e"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::nodes" ref="ad18c145fb4f30b90c7f7a93f9b36417e" args="() const " -->
std::vector&lt; std::pair&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a>, <br class="typebreak"/>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>nodes</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Observer interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_zero_inflation_curve.html#ac5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae111cb608a73ca819237b5c9f93f1088"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::Bootstrap&lt; this_curve &gt;" ref="ae111cb608a73ca819237b5c9f93f1088" args="" -->
class&#160;</td><td class="memItemRight" valign="bottom"><b>Bootstrap&lt; this_curve &gt;</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e9e8eaf5be1d62515629611b40421e"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::BootstrapError&lt; this_curve &gt;" ref="a57e9e8eaf5be1d62515629611b40421e" args="" -->
class&#160;</td><td class="memItemRight" valign="bottom"><b>BootstrapError&lt; this_curve &gt;</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Interpolator, template&lt; class &gt; class Bootstrap = IterativeBootstrap, class Traits = ZeroInflationTraits&gt;<br/>
class QuantLib::PiecewiseZeroInflationCurve&lt; Interpolator, Bootstrap, Traits &gt;</h3>

<p>Piecewise zero-inflation term structure. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a872006051a1b47c481388e2f5313fd91"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::baseDate" ref="a872006051a1b47c481388e2f5313fd91" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_quant_lib_1_1_date.html">Date</a> <a class="el" href="class_quant_lib_1_1_piecewise_zero_inflation_curve.html#a872006051a1b47c481388e2f5313fd91">baseDate</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>minimum (base) date </p>
<p>Important in inflation since it starts before nominal reference date. Changes depending whether index is interpolated or not. When interpolated the base date is just observation lag before nominal. When not interpolated it is the beginning of the relevant period (hence it is easy to create interpolated fixings from a not-interpolated curve because interpolation, usually, of fixings is forward looking). </p>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_interpolated_zero_inflation_curve.html#a872006051a1b47c481388e2f5313fd91">InterpolatedZeroInflationCurve&lt; Interpolator &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::PiecewiseZeroInflationCurve::update" ref="ac5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_piecewise_zero_inflation_curve.html#ac5c54df7ed3b930268c8d7752c101725">update</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><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>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_lazy_object.html#ac5c54df7ed3b930268c8d7752c101725">LazyObject</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>