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
|
<!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: InterpolatedForwardCurve 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_interpolated_forward_curve.html">InterpolatedForwardCurve</a></div>
<h1>InterpolatedForwardCurve Class Template Reference<br>
<small>
[<a class="el" href="group__yieldtermstructures.html">Term structures</a>]</small>
</h1><!-- doxytag: class="QuantLib::InterpolatedForwardCurve" --><!-- doxytag: inherits="QuantLib::ForwardRateStructure" --><code>#include <ql/termstructures/yield/forwardcurve.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for InterpolatedForwardCurve:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_interpolated_forward_curve__inherit__graph.png" border="0" usemap="#_interpolated_forward_curve__inherit__map" alt="Inheritance graph"></center>
<map name="_interpolated_forward_curve__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_forward_rate_structure.html" title="Forward-rate term structure" alt="" coords="19,7,184,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_interpolated_forward_curve-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class Interpolator><br>
class QuantLib::InterpolatedForwardCurve< Interpolator ></h3>
Term structure based on interpolation of forward rates.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Inspectors</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="361b6eadf2fb8b49e1a53073e0f8f11d"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::dates_" ref="361b6eadf2fb8b49e1a53073e0f8f11d" args="" -->
std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > </td><td class="memItemRight" valign="bottom"><b>dates_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63b1ac1fe6074fcd9789119e547d4812"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::times_" ref="63b1ac1fe6074fcd9789119e547d4812" args="" -->
std::vector< <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > </td><td class="memItemRight" valign="bottom"><b>times_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2cfdb13a3f0fbd4efe7a0cf58b237163"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::data_" ref="2cfdb13a3f0fbd4efe7a0cf58b237163" args="" -->
std::vector< <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> > </td><td class="memItemRight" valign="bottom"><b>data_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6633ee38a9d12ce3e342081d39e98fd0"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::interpolation_" ref="6633ee38a9d12ce3e342081d39e98fd0" args="" -->
<a class="el" href="class_quant_lib_1_1_interpolation.html">Interpolation</a> </td><td class="memItemRight" valign="bottom"><b>interpolation_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b466578f592f91a3a636714cbcdfa20"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::interpolator_" ref="4b466578f592f91a3a636714cbcdfa20" args="" -->
Interpolator </td><td class="memItemRight" valign="bottom"><b>interpolator_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::maxDate" ref="74d8fc5480ca811db8332b7b30597fe9" 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_interpolated_forward_curve.html#74d8fc5480ca811db8332b7b30597fe9">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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a338cfa77dc3c8dc467f4225459094fd"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::times" ref="a338cfa77dc3c8dc467f4225459094fd" args="() const " -->
const std::vector< <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > & </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::InterpolatedForwardCurve::dates" ref="021de10463e6e18e294494d7cbb2b75d" 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" nowrap align="right" valign="top"><a class="anchor" name="5c239d4bdc99dae223cb2de026ea3925"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::forwards" ref="5c239d4bdc99dae223cb2de026ea3925" args="() const " -->
const std::vector< <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> > & </td><td class="memItemRight" valign="bottom"><b>forwards</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e36e55af23c117164f4329ad5daa9adf"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::nodes" ref="e36e55af23c117164f4329ad5daa9adf" args="() const " -->
std::vector< std::pair< <a class="el" href="class_quant_lib_1_1_date.html">Date</a>,<br>
<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> > > </td><td class="memItemRight" valign="bottom"><b>nodes</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5c593c15afaed6bf89ddb418c775ccb"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::InterpolatedForwardCurve" ref="b5c593c15afaed6bf89ddb418c775ccb" args="(const DayCounter &, const Interpolator &interpolator=Interpolator())" -->
</td><td class="memItemRight" valign="bottom"><b>InterpolatedForwardCurve</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &, const Interpolator &interpolator=Interpolator())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c49caaee03caca7ee77966ca04eda7b"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::InterpolatedForwardCurve" ref="0c49caaee03caca7ee77966ca04eda7b" args="(const Date &referenceDate, const DayCounter &, const Interpolator &interpolator=Interpolator())" -->
</td><td class="memItemRight" valign="bottom"><b>InterpolatedForwardCurve</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_day_counter.html">DayCounter</a> &, const Interpolator &interpolator=Interpolator())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="085fb52e2efdcac9de5808e5c5f7723a"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::InterpolatedForwardCurve" ref="085fb52e2efdcac9de5808e5c5f7723a" args="(Natural settlementDays, const Calendar &, const DayCounter &, const Interpolator &interpolator=Interpolator())" -->
</td><td class="memItemRight" valign="bottom"><b>InterpolatedForwardCurve</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> &, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &, const Interpolator &interpolator=Interpolator())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9a0dab6e2bfb4a21dce277a40fcf928"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::forwardImpl" ref="f9a0dab6e2bfb4a21dce277a40fcf928" args="(Time t) const " -->
<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_interpolated_forward_curve.html#f9a0dab6e2bfb4a21dce277a40fcf928">forwardImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">instantaneous forward-rate calculation <br></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_interpolated_forward_curve.html#7b3637b3975a6b4b75b71f31793d4687">zeroYieldImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="85070e858616381ea63fb004637d4595"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::InterpolatedForwardCurve" ref="85070e858616381ea63fb004637d4595" args="(const std::vector< Date > &dates, const std::vector< Rate > &forwards, const DayCounter &dayCounter, const Interpolator &interpolator=Interpolator())" -->
</td><td class="memItemRight" valign="bottom"><b>InterpolatedForwardCurve</b> (const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &dates, const std::vector< <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> > &forwards, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dayCounter, const Interpolator &interpolator=Interpolator())</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7b3637b3975a6b4b75b71f31793d4687"></a><!-- doxytag: member="QuantLib::InterpolatedForwardCurve::zeroYieldImpl" ref="7b3637b3975a6b4b75b71f31793d4687" args="(Time t) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> zeroYieldImpl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the zero yield rate for the given date calculating it from the instantaneous forward rate.<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000105">Warning:</a></b></dt><dd>This is just a default, highly inefficient and possibly wildly inaccurate implementation. Derived classes should implement their own zeroYield method. </dd></dl>
<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_forward_rate_structure.html#c5fe572646475bf02f83c3bedfca9a61">ForwardRateStructure</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>
|