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
|
<!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: ZeroInflationTermStructure 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_zero_inflation_term_structure.html">ZeroInflationTermStructure</a></div>
<h1>ZeroInflationTermStructure Class Reference</h1><!-- doxytag: class="QuantLib::ZeroInflationTermStructure" --><!-- doxytag: inherits="QuantLib::InflationTermStructure" --><code>#include <ql/termstructures/inflationtermstructure.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for ZeroInflationTermStructure:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_zero_inflation_term_structure__inherit__graph.png" border="0" usemap="#_zero_inflation_term_structure__inherit__map" alt="Inheritance graph"></center>
<map name="_zero_inflation_term_structure__inherit__map">
<area shape="rect" 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,161,227,188"><area shape="rect" href="class_quant_lib_1_1_inflation_term_structure.html" title="Interface for inflation term structures." alt="" coords="33,7,199,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_zero_inflation_term_structure-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface for zero inflation term structures. <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 colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f75891d452f848b75a61fad9112eb0af"></a><!-- doxytag: member="QuantLib::ZeroInflationTermStructure::ZeroInflationTermStructure" ref="f75891d452f848b75a61fad9112eb0af" args="(const DayCounter &dayCounter, const Period &lag, Frequency frequency, Rate baseZeroRate, const Handle< YieldTermStructure > &yTS)" -->
</td><td class="memItemRight" valign="bottom"><b>ZeroInflationTermStructure</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &lag, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> baseZeroRate, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &yTS)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5872cfebb8da7d047c11792a4d3c8068"></a><!-- doxytag: member="QuantLib::ZeroInflationTermStructure::ZeroInflationTermStructure" ref="5872cfebb8da7d047c11792a4d3c8068" args="(const Date &referenceDate, const Calendar &calendar, const DayCounter &dayCounter, const Period &lag, Frequency frequency, Rate baseZeroRate, const Handle< YieldTermStructure > &yTS)" -->
</td><td class="memItemRight" valign="bottom"><b>ZeroInflationTermStructure</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &referenceDate, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &calendar, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &lag, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> baseZeroRate, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &yTS)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1247e4c1683bbd6309fffbc3b00e3963"></a><!-- doxytag: member="QuantLib::ZeroInflationTermStructure::ZeroInflationTermStructure" ref="1247e4c1683bbd6309fffbc3b00e3963" args="(Natural settlementDays, const Calendar &calendar, const DayCounter &dayCounter, const Period &lag, Frequency frequency, Rate baseZeroRate, const Handle< YieldTermStructure > &yTS)" -->
</td><td class="memItemRight" valign="bottom"><b>ZeroInflationTermStructure</b> (<a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &calendar, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &lag, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> baseZeroRate, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &yTS)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></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_zero_inflation_term_structure.html#8700818cc76b1da2ca6a0c246f0df424">zeroRate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d, bool extrapolate=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">zero-coupon inflation rate <a href="#8700818cc76b1da2ca6a0c246f0df424"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f53e7de10a1fd168a5cafe1f5b924bf"></a><!-- doxytag: member="QuantLib::ZeroInflationTermStructure::zeroRate" ref="8f53e7de10a1fd168a5cafe1f5b924bf" args="(Time t, bool extrapolate=false) const " -->
<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><b>zeroRate</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, bool extrapolate=false) const </td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca52e7fe785fca72b56319107c8f47b0"></a><!-- doxytag: member="QuantLib::ZeroInflationTermStructure::zeroRateImpl" ref="ca52e7fe785fca72b56319107c8f47b0" args="(Time t) const =0" -->
virtual <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_zero_inflation_term_structure.html#ca52e7fe785fca72b56319107c8f47b0">zeroRateImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">to be defined in derived classes <br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8700818cc76b1da2ca6a0c246f0df424"></a><!-- doxytag: member="QuantLib::ZeroInflationTermStructure::zeroRate" ref="8700818cc76b1da2ca6a0c246f0df424" args="(const Date &d, bool extrapolate=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> zeroRate </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>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>extrapolate</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
zero-coupon inflation rate
<p>
Essentially the fair rate for a zero-coupon inflation swap (by definition), i.e. the zero term structure uses yearly compounding, which is assumed for ZCIIS instrument quotes.
</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>
|