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
|
<!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>ZeroCouponInflationSwapHelper 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_coupon_inflation_swap_helper.html">ZeroCouponInflationSwapHelper</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">ZeroCouponInflationSwapHelper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::ZeroCouponInflationSwapHelper" --><!-- doxytag: inherits="BootstrapHelper< ZeroInflationTermStructure >" -->
<p>Zero-coupon inflation-swap bootstrap helper.
<a href="class_quant_lib_1_1_zero_coupon_inflation_swap_helper.html#details">More...</a></p>
<p><code>#include <ql/termstructures/inflation/inflationhelpers.hpp></code></p>
<div class="dynheader">
Inheritance diagram for ZeroCouponInflationSwapHelper:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_zero_coupon_inflation_swap_helper__inherit__graph.png" border="0" usemap="#_zero_coupon_inflation_swap_helper_inherit__map" alt="Inheritance graph"/></div>
<map name="_zero_coupon_inflation_swap_helper_inherit__map" id="_zero_coupon_inflation_swap_helper_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_bootstrap_helper.html" title="BootstrapHelper\< ZeroInflationTermStructure \>" alt="" coords="5,6,296,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_coupon_inflation_swap_helper-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="a4e70e51e74933ab62b4ba54fa33c73e3"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::ZeroCouponInflationSwapHelper" ref="a4e70e51e74933ab62b4ba54fa33c73e3" args="(const Handle< Quote > &quote, const Period &swapObsLag, const Date &maturity, const Calendar &calendar, BusinessDayConvention paymentConvention, const DayCounter &dayCounter, const boost::shared_ptr< ZeroInflationIndex > &zii)" -->
 </td><td class="memItemRight" valign="bottom"><b>ZeroCouponInflationSwapHelper</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > &quote, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &swapObsLag, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &maturity, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &calendar, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> paymentConvention, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_zero_inflation_index.html">ZeroInflationIndex</a> > &zii)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_zero_coupon_inflation_swap_helper.html#a70ad3f5015feaac40fbe9ccb8cc04ee4">setTermStructure</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">sets the term structure to be used for pricing <a href="#a70ad3f5015feaac40fbe9ccb8cc04ee4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c69887bf51d43666aa7d5edfe124c0a"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::impliedQuote" ref="a9c69887bf51d43666aa7d5edfe124c0a" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>impliedQuote</b> () const </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="a7a5037e9b29ab7cf7525523ec0c4b819"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::swapObsLag_" ref="a7a5037e9b29ab7cf7525523ec0c4b819" args="" -->
<a class="el" href="class_quant_lib_1_1_period.html">Period</a> </td><td class="memItemRight" valign="bottom"><b>swapObsLag_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33de34dc880e36d57a65c417746e007d"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::maturity_" ref="a33de34dc880e36d57a65c417746e007d" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>maturity_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a021eab7f1f44c1c71b8dfd29b9c4864b"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::calendar_" ref="a021eab7f1f44c1c71b8dfd29b9c4864b" args="" -->
<a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> </td><td class="memItemRight" valign="bottom"><b>calendar_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0c2ba6da16ec8c201da972e61b08334"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::paymentConvention_" ref="ab0c2ba6da16ec8c201da972e61b08334" args="" -->
<a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> </td><td class="memItemRight" valign="bottom"><b>paymentConvention_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76c6c2d60ef1370e20bdf40a0e0ca642"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::dayCounter_" ref="a76c6c2d60ef1370e20bdf40a0e0ca642" args="" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> </td><td class="memItemRight" valign="bottom"><b>dayCounter_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4064f2c439f59fac49c7b7205e530132"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::zii_" ref="a4064f2c439f59fac49c7b7205e530132" args="" -->
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>zii_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad55666e2a9be61340a39d1ad6e4fe4b8"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::zciis_" ref="ad55666e2a9be61340a39d1ad6e4fe4b8" args="" -->
boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_zero_coupon_inflation_swap.html">ZeroCouponInflationSwap</a> > </td><td class="memItemRight" valign="bottom"><b>zciis_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Zero-coupon inflation-swap bootstrap helper. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a70ad3f5015feaac40fbe9ccb8cc04ee4"></a><!-- doxytag: member="QuantLib::ZeroCouponInflationSwapHelper::setTermStructure" ref="a70ad3f5015feaac40fbe9ccb8cc04ee4" args="(ZeroInflationTermStructure *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_quant_lib_1_1_zero_coupon_inflation_swap_helper.html#a70ad3f5015feaac40fbe9ccb8cc04ee4">setTermStructure</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_quant_lib_1_1_zero_inflation_term_structure.html">ZeroInflationTermStructure</a> * </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the term structure to be used for pricing </p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000107">Warning:</a></b></dt><dd>Being a pointer and not a shared_ptr, the term structure is not guaranteed to remain allocated for the whole life of the rate helper. It is responsibility of the programmer to ensure that the pointer remains valid. It is advised that this method is called only inside the term structure being bootstrapped, setting the pointer to <b>this</b>, i.e., the term structure itself. </dd></dl>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_bootstrap_helper.html#ac8bb5ca2d4e7d7754be9f69e43a054ce">BootstrapHelper< ZeroInflationTermStructure ></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>
|
