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
|
<!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>PiecewiseYieldCurve< Traits, Interpolator, Bootstrap > 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_yield_curve.html">PiecewiseYieldCurve</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">PiecewiseYieldCurve< Traits, Interpolator, Bootstrap > Class Template 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::PiecewiseYieldCurve" --><!-- doxytag: inherits="Traits::template curve::type,QuantLib::LazyObject" -->
<p>Piecewise yield term structure.
<a href="class_quant_lib_1_1_piecewise_yield_curve.html#details">More...</a></p>
<p><code>#include <ql/termstructures/yield/piecewiseyieldcurve.hpp></code></p>
<div class="dynheader">
Inheritance diagram for PiecewiseYieldCurve< Traits, Interpolator, Bootstrap >:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_piecewise_yield_curve__inherit__graph.png" border="0" usemap="#_piecewise_yield_curve_3_01_traits_00_01_interpolator_00_01_bootstrap_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_piecewise_yield_curve_3_01_traits_00_01_interpolator_00_01_bootstrap_01_4_inherit__map" id="_piecewise_yield_curve_3_01_traits_00_01_interpolator_00_01_bootstrap_01_4_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="129,6,217,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_yield_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::PiecewiseYieldCurve::traits_type" ref="aada8c38edc7a4968494c4838ecfd99ce" args="" -->
typedef Traits </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::PiecewiseYieldCurve::interpolator_type" ref="a89a0f20565fc38a4735f79b7c6deeed7" args="" -->
typedef Interpolator </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="a75ba9b03a2b10ba532be31612b2b0f20"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="a75ba9b03a2b10ba532be31612b2b0f20" args="(const Date &referenceDate, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const DayCounter &dayCounter, const std::vector< Handle< Quote > > &jumps=std::vector< Handle< Quote > >(), const std::vector< Date > &jumpDates=std::vector< Date >(), Real accuracy=1.0e-12, const Interpolator &i=Interpolator(), const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &referenceDate, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, 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> > > &jumps=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> > >(), const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &jumpDates=std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> >(), <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-12, const Interpolator &i=Interpolator(), const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aea2e4071d832165b349e3c2995d51c"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="a1aea2e4071d832165b349e3c2995d51c" args="(const Date &referenceDate, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const DayCounter &dayCounter, Real accuracy, const Interpolator &i=Interpolator(), const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &referenceDate, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy, const Interpolator &i=Interpolator(), const Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> > &bootstrap=Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae90b3c44242a55102aa39365f79f7241"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="ae90b3c44242a55102aa39365f79f7241" args="(const Date &referenceDate, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const DayCounter &dayCounter, const Interpolator &i, const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &referenceDate, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const Interpolator &i, const Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> > &bootstrap=Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0d184352744040ac7781af9b6dcadf7"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="af0d184352744040ac7781af9b6dcadf7" args="(Natural settlementDays, const Calendar &calendar, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const DayCounter &dayCounter, const std::vector< Handle< Quote > > &jumps=std::vector< Handle< Quote > >(), const std::vector< Date > &jumpDates=std::vector< Date >(), Real accuracy=1.0e-12, const Interpolator &i=Interpolator(), const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &calendar, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, 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> > > &jumps=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> > >(), const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &jumpDates=std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> >(), <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy=1.0e-12, const Interpolator &i=Interpolator(), const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7e19a0e521d5b812e36e3680456e303"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="ae7e19a0e521d5b812e36e3680456e303" args="(Natural settlementDays, const Calendar &calendar, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const DayCounter &dayCounter, Real accuracy, const Interpolator &i=Interpolator(), const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &calendar, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> accuracy, const Interpolator &i=Interpolator(), const Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> > &bootstrap=Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a312702b74eca72da685aee04f8cd40c3"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PiecewiseYieldCurve" ref="a312702b74eca72da685aee04f8cd40c3" args="(Natural settlementDays, const Calendar &calendar, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const DayCounter &dayCounter, const Interpolator &i, const Bootstrap< this_curve > &bootstrap=Bootstrap< this_curve >())" -->
 </td><td class="memItemRight" valign="bottom"><b>PiecewiseYieldCurve</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &calendar, const std::vector< boost::shared_ptr< typename Traits::helper > > &instruments, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const Interpolator &i, const Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> > &bootstrap=Bootstrap< <a class="el" href="class_quant_lib_1_1_piecewise_yield_curve.html">this_curve</a> >())</td></tr>
<tr><td colspan="2"><div class="groupHeader">TermStructure interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::maxDate" ref="a74d8fc5480ca811db8332b7b30597fe9" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>maxDate</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">base_curve interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa338cfa77dc3c8dc467f4225459094fd"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::times" ref="aa338cfa77dc3c8dc467f4225459094fd" args="() const " -->
const std::vector< <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > & </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::PiecewiseYieldCurve::dates" ref="a021de10463e6e18e294494d7cbb2b75d" args="() const " -->
const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > & </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::PiecewiseYieldCurve::data" ref="ac4cb0310cb2b45d6d243dd93f5d0b00f" args="() const " -->
const std::vector< <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> > & </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::PiecewiseYieldCurve::nodes" ref="ad18c145fb4f30b90c7f7a93f9b36417e" args="() const " -->
std::vector< std::pair< <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> > > </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_piecewise_yield_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::PiecewiseYieldCurve::Bootstrap< this_curve >" ref="ae111cb608a73ca819237b5c9f93f1088" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Bootstrap< this_curve ></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e9e8eaf5be1d62515629611b40421e"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::BootstrapError< this_curve >" ref="a57e9e8eaf5be1d62515629611b40421e" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>BootstrapError< this_curve ></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca3f88b9684e23193ac4481984646966"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::PenaltyFunction< this_curve >" ref="aca3f88b9684e23193ac4481984646966" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>PenaltyFunction< this_curve ></b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Traits, class Interpolator, template< class > class Bootstrap = IterativeBootstrap><br/>
class QuantLib::PiecewiseYieldCurve< Traits, Interpolator, Bootstrap ></h3>
<p>Piecewise yield term structure. </p>
<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>
<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 class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000140">Warning:</a></b></dt><dd>The bootstrapping algorithm will raise an exception if any two instruments have the same maturity date.</dd></dl>
<dl class="test"><dt><b><a class="el" href="test.html#_test000142">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><dt><b>Examples: </b></dt><dd><a class="el" href="_bonds_8cpp-example.html#_a28">Bonds.cpp</a>, <a class="el" href="_fitted_bond_curve_8cpp-example.html#_a23">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#_a14">FRA.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#_a26">swapvaluation.cpp</a>.</dd>
</dl></div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::PiecewiseYieldCurve::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_yield_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>
|