File: class_quant_lib_1_1_piecewise_yield_curve.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (169 lines) | stat: -rw-r--r-- 12,323 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
<!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: PiecewiseYieldCurve 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="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_piecewise_yield_curve.html">PiecewiseYieldCurve</a></div>
<h1>PiecewiseYieldCurve Class Template Reference<br>
<small>
[<a class="el" href="group__yieldtermstructures.html">Term structures</a>]</small>
</h1><!-- doxytag: class="QuantLib::PiecewiseYieldCurve" --><!-- doxytag: inherits="Traits::template curve::type,QuantLib::LazyObject" --><code>#include &lt;ql/termstructures/yield/piecewiseyieldcurve.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PiecewiseYieldCurve:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_piecewise_yield_curve__inherit__graph.png" border="0" usemap="#_piecewise_yield_curve__inherit__map" alt="Inheritance graph"></center>
<map name="_piecewise_yield_curve__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="36,7,129,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_piecewise_yield_curve-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class Traits, class Interpolator, template&lt; class, class, class &gt; class Bootstrap = IterativeBootstrap&gt;<br>
 class QuantLib::PiecewiseYieldCurve&lt; Traits, Interpolator, Bootstrap &gt;</h3>

Piecewise yield term structure. 
<p>
This term structure is bootstrapped on a number of interest rate instruments which are passed as a vector of handles to RateHelper instances. Their maturities mark the boundaries of the interpolated segments.<p>
Each segment is determined sequentially starting from the earliest period to the latest and is chosen so that the instrument whose maturity marks the end of such segment is correctly repriced on the curve.<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000108">Warning:</a></b></dt><dd>The bootstrapping algorithm will raise an exception if any two instruments have the same maturity date.</dd></dl>
<p>
<dl compact><dt><b><a class="el" href="test.html#_test000121">Tests:</a></b></dt><dd><ul>
<li>the correctness of the returned values is tested by checking them against the original inputs.</li><li>the observability of the term structure is tested. </li></ul>
</dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_fitted_bond_curve_8cpp-example.html#_a20">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#_a13">FRA.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#_a23">swapvaluation.cpp</a>.</dl><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="dd69c2e3341be2b4913f522170f7dfff"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="dd69c2e3341be2b4913f522170f7dfff" args="(const Date &amp;referenceDate, const std::vector&lt; boost::shared_ptr&lt; typename Traits::helper &gt; &gt; &amp;instruments, const DayCounter &amp;dayCounter, Real accuracy=1.0e-12, const Interpolator &amp;i=Interpolator())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate, const std::vector&lt; boost::shared_ptr&lt; typename Traits::helper &gt; &gt; &amp;instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-12, const Interpolator &amp;i=Interpolator())</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7cbcf5e293a8ae24638f9f43c6386028"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="7cbcf5e293a8ae24638f9f43c6386028" args="(Natural settlementDays, const Calendar &amp;calendar, const std::vector&lt; boost::shared_ptr&lt; typename Traits::helper &gt; &gt; &amp;instruments, const DayCounter &amp;dayCounter, Real accuracy=1.0e-12, const Interpolator &amp;i=Interpolator())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</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> &amp;calendar, const std::vector&lt; boost::shared_ptr&lt; typename Traits::helper &gt; &gt; &amp;instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-12, const Interpolator &amp;i=Interpolator())</td></tr>

<tr><td colspan="2"><div class="groupHeader">YieldTermStructure interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::maxDate" ref="74d8fc5480ca811db8332b7b30597fe9" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxDate</b> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a338cfa77dc3c8dc467f4225459094fd"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::times" ref="a338cfa77dc3c8dc467f4225459094fd" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>times</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="021de10463e6e18e294494d7cbb2b75d"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::dates" ref="021de10463e6e18e294494d7cbb2b75d" args="() const " -->
const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>dates</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4cb0310cb2b45d6d243dd93f5d0b00f"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::data" ref="c4cb0310cb2b45d6d243dd93f5d0b00f" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>data</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d18c145fb4f30b90c7f7a93f9b36417e"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::nodes" ref="d18c145fb4f30b90c7f7a93f9b36417e" args="() const " -->
std::vector&lt; std::pair&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a>,<br>
 <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &gt;&nbsp;</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" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46d9677dc88c4e022697785a08c068f0"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::Bootstrap&lt; PiecewiseYieldCurve&lt; Traits, Interpolator, Bootstrap &gt;, Traits, Interpolator &gt;" ref="46d9677dc88c4e022697785a08c068f0" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Bootstrap&lt; PiecewiseYieldCurve&lt; Traits, Interpolator, Bootstrap &gt;, Traits, Interpolator &gt;</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8740fd93a98771f2eb2997c882ed4c4"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::BootstrapError&lt; PiecewiseYieldCurve&lt; Traits, Interpolator, Bootstrap &gt;, Traits, Interpolator &gt;" ref="c8740fd93a98771f2eb2997c882ed4c4" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>BootstrapError&lt; PiecewiseYieldCurve&lt; Traits, Interpolator, Bootstrap &gt;, Traits, Interpolator &gt;</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::update" ref="c5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void update           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><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>Reimplemented from <a class="el" href="class_quant_lib_1_1_lazy_object.html#c5c54df7ed3b930268c8d7752c101725">LazyObject</a>.</p>

</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>