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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
|
<!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: YieldTermStructure 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_yield_term_structure.html">YieldTermStructure</a></div>
<h1>YieldTermStructure Class Reference<br>
<small>
[<a class="el" href="group__yieldtermstructures.html">Term structures</a>]</small>
</h1><!-- doxytag: class="QuantLib::YieldTermStructure" --><!-- doxytag: inherits="QuantLib::TermStructure" --><code>#include <ql/termstructures/yieldtermstructure.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for YieldTermStructure:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_yield_term_structure__inherit__graph.png" border="0" usemap="#_yield_term_structure__inherit__map" alt="Inheritance graph"></center>
<map name="_yield_term_structure__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_fitted_bond_discount_curve.html" title="Discount curve fitted to a set of fixed-coupon bonds." alt="" coords="445,5,632,32"><area shape="rect" href="class_quant_lib_1_1_flat_forward.html" title="Flat interest-rate curve." alt="" coords="489,56,588,83"><area shape="rect" href="class_quant_lib_1_1_forward_rate_structure.html" title="Forward-rate term structure" alt="" coords="456,107,621,133"><area shape="rect" href="class_quant_lib_1_1_implied_term_structure.html" title="Implied term structure at a given date in the future." alt="" coords="459,157,619,184"><area shape="rect" href="class_quant_lib_1_1_interpolated_discount_curve.html" title="Term structure based on interpolation of discount factors." alt="" coords="441,208,636,235"><area shape="rect" href="class_quant_lib_1_1_interpolated_discount_curve.html" title="InterpolatedDiscountCurve\< QuantLib::LogLinear \>" alt="" coords="361,259,716,285"><area shape="rect" href="class_quant_lib_1_1_zero_yield_structure.html" title="Zero-yield term structure." alt="" coords="468,309,609,336"><area shape="rect" href="class_quant_lib_1_1_term_structure.html" title="Basic term-structure functionality." alt="" coords="7,157,119,184"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_yield_term_structure-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interest-rate term structure.
<p>
This abstract class defines the interface of concrete rate structures which will be derived from this one.<p>
Rates are assumed to be annual continuous compounding.<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000054">Possible enhancements:</a></b></dt><dd>add derived class ParSwapTermStructure similar to ZeroYieldTermStructure, DiscountStructure, <a class="el" href="class_quant_lib_1_1_forward_rate_structure.html" title="Forward-rate term structure">ForwardRateStructure</a></dd></dl>
<p>
<dl compact><dt><b><a class="el" href="test.html#_test000123">Tests:</a></b></dt><dd>observability against evaluation date changes is checked. </dd></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 colspan="2"><div class="groupText">See the TermStructure documentation for issues regarding constructors. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#7985e20177b67f441f758b22bc138f95">YieldTermStructure</a> (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 class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#7985e20177b67f441f758b22bc138f95"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1deb289c9966b64f5e9c55971abd5d2"></a><!-- doxytag: member="QuantLib::YieldTermStructure::YieldTermStructure" ref="e1deb289c9966b64f5e9c55971abd5d2" args="(const Date &referenceDate, const Calendar &cal=Calendar(), const DayCounter &dc=DayCounter())" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#e1deb289c9966b64f5e9c55971abd5d2">YieldTermStructure</a> (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> &cal=<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> &dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">initialize with a fixed reference date <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="216f1e8a99e92f5f6fb0d93cde929679"></a><!-- doxytag: member="QuantLib::YieldTermStructure::YieldTermStructure" ref="216f1e8a99e92f5f6fb0d93cde929679" args="(Natural settlementDays, const Calendar &cal, const DayCounter &dc=DayCounter())" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#216f1e8a99e92f5f6fb0d93cde929679">YieldTermStructure</a> (<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> &cal, 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 class="mdescLeft"> </td><td class="mdescRight">calculate the reference date based on the global evaluation date <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">zero-yield rates</div></td></tr>
<tr><td colspan="2"><div class="groupText">These methods return the implied zero-yield rate for a given date or time. In the former case, the time is calculated as a fraction of year from the reference date. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#12972ab974483ed401a4d9590b75535f">zeroRate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &resultDayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> comp, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#082588804109bda287be685bf25951ff">zeroRate</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> comp, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">discount factors</div></td></tr>
<tr><td colspan="2"><div class="groupText">These methods return the discount factor for a given date or time. In the former case, the time is calculated as a fraction of year from the reference date. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6355d9d4c5c2cff5ca61c9eae5b973e0"></a><!-- doxytag: member="QuantLib::YieldTermStructure::discount" ref="6355d9d4c5c2cff5ca61c9eae5b973e0" args="(const Date &, bool extrapolate=false) const " -->
<a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> </td><td class="memItemRight" valign="bottom"><b>discount</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &, bool extrapolate=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#4b2003db93d76ad8c4c348ac56eece39">discount</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, bool extrapolate=false) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">forward rates</div></td></tr>
<tr><td colspan="2"><div class="groupText">These methods returns the implied forward interest rate between two dates or times. In the former case, times are calculated as fractions of year from the reference date. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#7a4a0acc869b6696002755cfe9848000">forwardRate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d1, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d2, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &resultDayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> comp, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#7bb62afcfd21cdc31aa6f38a01f1f6be">forwardRate</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &p, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &resultDayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> comp, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#8b99c32181c270e69d3c5b985f4a95aa">forwardRate</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t1, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t2, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> comp, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </td></tr>
<tr><td colspan="2"><div class="groupHeader">par rates</div></td></tr>
<tr><td colspan="2"><div class="groupText">These methods returns the implied par rate for a given sequence of payments at the given dates or times. In the former case, times are calculated as fractions of year from the reference date.<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000111">Warning:</a></b></dt><dd>though somewhat related to a swap rate, this method is not to be used for the fair rate of a real swap, since it does not take into account all the market conventions' details. The correct way to evaluate such rate is to instantiate a SimpleSwap with the correct conventions, pass it the term structure and call the swap's fairRate() method. </dd></dl>
<br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd95a62f7da4d499cfe47bc47787aeb7"></a><!-- doxytag: member="QuantLib::YieldTermStructure::parRate" ref="cd95a62f7da4d499cfe47bc47787aeb7" args="(Integer tenor, const Date &startDate, Frequency freq=Annual, bool extrapolate=false) const " -->
<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><b>parRate</b> (<a class="el" href="group__types.html#gb9c87440c314438e51a899a03d2442d0">Integer</a> tenor, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &startDate, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </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_yield_term_structure.html#b1dc91f95c8067e702bc1440a32726df">parRate</a> (const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &dates, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </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_yield_term_structure.html#892764814d71ac972c8d6f4c5780922b">parRate</a> (const std::vector< <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > &times, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq=Annual, bool extrapolate=false) const </td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Calculations</div></td></tr>
<tr><td colspan="2"><div class="groupText">These methods must be implemented in derived classes to perform the actual discount and rate calculations. When they are called, range check has already been performed; therefore, they must assume that extrapolation is required. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe73bf9ae8077e99d6edde6ea309e991"></a><!-- doxytag: member="QuantLib::YieldTermStructure::discountImpl" ref="fe73bf9ae8077e99d6edde6ea309e991" args="(Time) const =0" -->
virtual <a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html#fe73bf9ae8077e99d6edde6ea309e991">discountImpl</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">discount calculation <br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7985e20177b67f441f758b22bc138f95"></a><!-- doxytag: member="QuantLib::YieldTermStructure::YieldTermStructure" ref="7985e20177b67f441f758b22bc138f95" args="(const DayCounter &dc=DayCounter())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"> <em>dc</em> = <code><a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>()</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
default constructor
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000109">Warning:</a></b></dt><dd>term structures initialized by means of this constructor must manage their own reference date by overriding the <a class="el" href="class_quant_lib_1_1_term_structure.html#a9ae6cc6009ac64d4f265065eab08be0" title="the date at which discount = 1.0 and/or variance = 0.0">referenceDate()</a> method. </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="12972ab974483ed401a4d9590b75535f"></a><!-- doxytag: member="QuantLib::YieldTermStructure::zeroRate" ref="12972ab974483ed401a4d9590b75535f" args="(const Date &d, const DayCounter &resultDayCounter, Compounding comp, Frequency freq=Annual, bool extrapolate=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</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">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"> <em>resultDayCounter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> </td>
<td class="paramname"> <em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
The resulting interest rate has the required daycounting rule.
</div>
</div><p>
<a class="anchor" name="082588804109bda287be685bf25951ff"></a><!-- doxytag: member="QuantLib::YieldTermStructure::zeroRate" ref="082588804109bda287be685bf25951ff" args="(Time t, Compounding comp, Frequency freq=Annual, bool extrapolate=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> zeroRate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> </td>
<td class="paramname"> <em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
The resulting interest rate has the same day-counting rule used by the term structure. The same rule should be used for calculating the passed time t.
</div>
</div><p>
<a class="anchor" name="4b2003db93d76ad8c4c348ac56eece39"></a><!-- doxytag: member="QuantLib::YieldTermStructure::discount" ref="4b2003db93d76ad8c4c348ac56eece39" args="(Time, bool extrapolate=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> discount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t</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>
The same day-counting rule used by the term structure should be used for calculating the passed time t.
</div>
</div><p>
<a class="anchor" name="7a4a0acc869b6696002755cfe9848000"></a><!-- doxytag: member="QuantLib::YieldTermStructure::forwardRate" ref="7a4a0acc869b6696002755cfe9848000" args="(const Date &d1, const Date &d2, const DayCounter &resultDayCounter, Compounding comp, Frequency freq=Annual, bool extrapolate=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> forwardRate </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>d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"> <em>resultDayCounter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> </td>
<td class="paramname"> <em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
The resulting interest rate has the required day-counting rule.
</div>
</div><p>
<a class="anchor" name="7bb62afcfd21cdc31aa6f38a01f1f6be"></a><!-- doxytag: member="QuantLib::YieldTermStructure::forwardRate" ref="7bb62afcfd21cdc31aa6f38a01f1f6be" args="(const Date &d, const Period &p, const DayCounter &resultDayCounter, Compounding comp, Frequency freq=Annual, bool extrapolate=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> forwardRate </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">const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> & </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"> <em>resultDayCounter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> </td>
<td class="paramname"> <em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
The resulting interest rate has the required day-counting rule. <dl compact><dt><b><a class="el" href="caveats.html#_caveats000110">Warning:</a></b></dt><dd>dates are not adjusted for holidays </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b99c32181c270e69d3c5b985f4a95aa"></a><!-- doxytag: member="QuantLib::YieldTermStructure::forwardRate" ref="8b99c32181c270e69d3c5b985f4a95aa" args="(Time t1, Time t2, Compounding comp, Frequency freq=Annual, bool extrapolate=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> forwardRate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"> <em>t2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> </td>
<td class="paramname"> <em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
The resulting interest rate has the same day-counting rule used by the term structure. The same rule should be used for the calculating the passed times t1 and t2.
</div>
</div><p>
<a class="anchor" name="b1dc91f95c8067e702bc1440a32726df"></a><!-- doxytag: member="QuantLib::YieldTermStructure::parRate" ref="b1dc91f95c8067e702bc1440a32726df" args="(const std::vector< Date > &dates, Frequency freq=Annual, 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> parRate </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > & </td>
<td class="paramname"> <em>dates</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
the first date in the vector must equal the start date; the following dates must equal the payment dates.
</div>
</div><p>
<a class="anchor" name="892764814d71ac972c8d6f4c5780922b"></a><!-- doxytag: member="QuantLib::YieldTermStructure::parRate" ref="892764814d71ac972c8d6f4c5780922b" args="(const std::vector< Time > &times, Frequency freq=Annual, 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> parRate </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > & </td>
<td class="paramname"> <em>times</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"> <em>freq</em> = <code>Annual</code>, </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>
the first time in the vector must equal the start time; the following times must equal the payment times.
</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>
|