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
|
<!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>PiecewiseZeroSpreadedTermStructure 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_piecewise_zero_spreaded_term_structure.html">PiecewiseZeroSpreadedTermStructure</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">PiecewiseZeroSpreadedTermStructure Class Reference<div class="ingroups"><a class="el" href="group__yieldtermstructures.html">Term structures</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::PiecewiseZeroSpreadedTermStructure" --><!-- doxytag: inherits="QuantLib::ZeroYieldStructure" -->
<p>Term structure with an added vector of spreads on the zero-yield rate.
<a href="class_quant_lib_1_1_piecewise_zero_spreaded_term_structure.html#details">More...</a></p>
<p><code>#include <ql/termstructures/yield/piecewisezerospreadedtermstructure.hpp></code></p>
<div class="dynheader">
Inheritance diagram for PiecewiseZeroSpreadedTermStructure:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_piecewise_zero_spreaded_term_structure__inherit__graph.png" border="0" usemap="#_piecewise_zero_spreaded_term_structure_inherit__map" alt="Inheritance graph"/></div>
<map name="_piecewise_zero_spreaded_term_structure_inherit__map" id="_piecewise_zero_spreaded_term_structure_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_zero_yield_structure.html" title="Zero-yield term structure." alt="" coords="63,6,191,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_spreaded_term_structure-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="a08ce7c74ee74b1205a2f53da9fae1f9f"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::PiecewiseZeroSpreadedTermStructure" ref="a08ce7c74ee74b1205a2f53da9fae1f9f" args="(const Handle< YieldTermStructure > &, const std::vector< Handle< Quote > > &spreads, const std::vector< Date > &dates, Compounding comp=Continuous, Frequency freq=NoFrequency, const DayCounter &dc=DayCounter())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseZeroSpreadedTermStructure</b> (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> > &, const std::vector< <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> > > &spreads, const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &dates, Compounding comp=Continuous, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=NoFrequency, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</td></tr>
<tr><td colspan="2"><div class="groupHeader">YieldTermStructure interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac147d63df367bbe5282b76b1f98cb9be"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::dayCounter" ref="ac147d63df367bbe5282b76b1f98cb9be" args="() const " -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_zero_spreaded_term_structure.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the day counter used for date/time conversion <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6506da60fec85c6f146f1b43116de70"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::settlementDays" ref="ab6506da60fec85c6f146f1b43116de70" args="() const " -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_zero_spreaded_term_structure.html#ab6506da60fec85c6f146f1b43116de70">settlementDays</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the settlementDays used for reference date calculation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9a0f3904cff2fe61596c593dd0b6448"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::calendar" ref="ae9a0f3904cff2fe61596c593dd0b6448" args="() const " -->
<a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_zero_spreaded_term_structure.html#ae9a0f3904cff2fe61596c593dd0b6448">calendar</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the calendar used for reference and/or option date calculation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5662908c63119a3b347a7e0ec8544afa"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::referenceDate" ref="a5662908c63119a3b347a7e0ec8544afa" args="() const " -->
const <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_piecewise_zero_spreaded_term_structure.html#a5662908c63119a3b347a7e0ec8544afa">referenceDate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the date at which discount = 1.0 and/or variance = 0.0 <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::maxDate" ref="a74d8fc5480ca811db8332b7b30597fe9" args="() const " -->
<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_piecewise_zero_spreaded_term_structure.html#a74d8fc5480ca811db8332b7b30597fe9">maxDate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the latest date for which the curve can return values <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5fe572646475bf02f83c3bedfca9a61"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::zeroYieldImpl" ref="ac5fe572646475bf02f83c3bedfca9a61" args="(Time) const " -->
<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_piecewise_zero_spreaded_term_structure.html#ac5fe572646475bf02f83c3bedfca9a61">zeroYieldImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the spreaded zero yield rate <br/></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_piecewise_zero_spreaded_term_structure.html#ac5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Term structure with an added vector of spreads on the zero-yield rate. </p>
<p>The zero-yield spread at any given date is linearly interpolated between the input data.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This term structure will remain linked to the original structure, i.e., any changes in the latter will be reflected in this structure as well. </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::PiecewiseZeroSpreadedTermStructure::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_spreaded_term_structure.html#ac5c54df7ed3b930268c8d7752c101725">update</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, 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_yield_term_structure.html#ac5c54df7ed3b930268c8d7752c101725">YieldTermStructure</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>
|
