File: class_quant_lib_1_1_zero_yield_structure.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (152 lines) | stat: -rw-r--r-- 13,519 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
<!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>ZeroYieldStructure 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_zero_yield_structure.html">ZeroYieldStructure</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">ZeroYieldStructure 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::ZeroYieldStructure" --><!-- doxytag: inherits="QuantLib::YieldTermStructure" -->
<p>Zero-yield term structure.  
 <a href="class_quant_lib_1_1_zero_yield_structure.html#details">More...</a></p>

<p><code>#include &lt;ql/termstructures/yield/zeroyieldstructure.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ZeroYieldStructure:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_zero_yield_structure__inherit__graph.png" border="0" usemap="#_zero_yield_structure_inherit__map" alt="Inheritance graph"/></div>
<map name="_zero_yield_structure_inherit__map" id="_zero_yield_structure_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_drift_term_structure.html" title="Drift term structure." alt="" coords="424,5,549,35"/><area shape="rect" id="node7" href="class_quant_lib_1_1_interpolated_zero_curve.html" title="YieldTermStructure based on interpolation of zero rates." alt="" coords="368,58,605,89"/><area shape="rect" id="node9" href="class_quant_lib_1_1_piecewise_zero_spreaded_term_structure.html" title="Term structure with an added vector of spreads on the zero&#45;yield rate." alt="" coords="365,111,608,142"/><area shape="rect" id="node11" href="class_quant_lib_1_1_quanto_term_structure.html" title="Quanto term structure." alt="" coords="413,165,560,195"/><area shape="rect" id="node13" href="class_quant_lib_1_1_zero_spreaded_term_structure.html" title="Term structure with an added spread on the zero yield rate." alt="" coords="395,218,579,249"/><area shape="rect" id="node2" href="class_quant_lib_1_1_yield_term_structure.html" title="Interest&#45;rate term structure." alt="" coords="5,111,139,142"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_zero_yield_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 colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>See the <a class="el" href="class_quant_lib_1_1_term_structure.html" title="Basic term-structure functionality.">TermStructure</a> documentation for issues regarding constructors. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a879bd44d37864155c62c4d561baadc8d"></a><!-- doxytag: member="QuantLib::ZeroYieldStructure::ZeroYieldStructure" ref="a879bd44d37864155c62c4d561baadc8d" args="(const DayCounter &amp;dc=DayCounter(), const std::vector&lt; Handle&lt; Quote &gt; &gt; &amp;jumps=std::vector&lt; Handle&lt; Quote &gt; &gt;(), const std::vector&lt; Date &gt; &amp;jumpDates=std::vector&lt; Date &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ZeroYieldStructure</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>(), const std::vector&lt; <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &gt; &amp;jumps=std::vector&lt; <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &gt;(), const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;jumpDates=std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af287d6e530508b687989352cbe0ce16f"></a><!-- doxytag: member="QuantLib::ZeroYieldStructure::ZeroYieldStructure" ref="af287d6e530508b687989352cbe0ce16f" args="(const Date &amp;referenceDate, const Calendar &amp;calendar=Calendar(), const DayCounter &amp;dc=DayCounter(), const std::vector&lt; Handle&lt; Quote &gt; &gt; &amp;jumps=std::vector&lt; Handle&lt; Quote &gt; &gt;(), const std::vector&lt; Date &gt; &amp;jumpDates=std::vector&lt; Date &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ZeroYieldStructure</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#aa9ae6cc6009ac64d4f265065eab08be0">referenceDate</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#ae9a0f3904cff2fe61596c593dd0b6448">calendar</a>=<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> &amp;dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>(), const std::vector&lt; <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &gt; &amp;jumps=std::vector&lt; <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &gt;(), const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;jumpDates=std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e457f34ac19db74df6a4d1a573f26e5"></a><!-- doxytag: member="QuantLib::ZeroYieldStructure::ZeroYieldStructure" ref="a5e457f34ac19db74df6a4d1a573f26e5" args="(Natural settlementDays, const Calendar &amp;calendar, const DayCounter &amp;dc=DayCounter(), const std::vector&lt; Handle&lt; Quote &gt; &gt; &amp;jumps=std::vector&lt; Handle&lt; Quote &gt; &gt;(), const std::vector&lt; Date &gt; &amp;jumpDates=std::vector&lt; Date &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ZeroYieldStructure</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> <a class="el" href="class_quant_lib_1_1_term_structure.html#ab6506da60fec85c6f146f1b43116de70">settlementDays</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;<a class="el" href="class_quant_lib_1_1_term_structure.html#ae9a0f3904cff2fe61596c593dd0b6448">calendar</a>, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dc=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>(), const std::vector&lt; <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &gt; &amp;jumps=std::vector&lt; <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &gt;(), const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;jumpDates=std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt;())</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Calculations</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>This method must be implemented in derived classes to perform the actual calculations. When it is called, range check has already been performed; therefore, it must assume that extrapolation is required. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a841c9841f67d21b682578d206fc915ec"></a><!-- doxytag: member="QuantLib::ZeroYieldStructure::zeroYieldImpl" ref="a841c9841f67d21b682578d206fc915ec" args="(Time) const =0" -->
virtual <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_zero_yield_structure.html#a841c9841f67d21b682578d206fc915ec">zeroYieldImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">zero-yield calculation <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">YieldTermStructure implementation</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_zero_yield_structure.html#a2c21d8d34e88bb0451cabdd4e280ab17">discountImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Zero-yield term structure. </p>
<p>This abstract class acts as an adapter to <a class="el" href="class_quant_lib_1_1_yield_term_structure.html" title="Interest-rate term structure.">YieldTermStructure</a> allowing the programmer to implement only the <code>zeroYieldImpl(Time)</code> method in derived classes.</p>
<p><a class="el" href="struct_quant_lib_1_1_discount.html" title="Discount-curve traits.">Discount</a> and forward are calculated from zero yields.</p>
<p>Zero rates are assumed to be annual continuous compounding. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2c21d8d34e88bb0451cabdd4e280ab17"></a><!-- doxytag: member="QuantLib::ZeroYieldStructure::discountImpl" ref="a2c21d8d34e88bb0451cabdd4e280ab17" args="(Time) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> <a class="el" href="class_quant_lib_1_1_zero_yield_structure.html#a2c21d8d34e88bb0451cabdd4e280ab17">discountImpl</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>&#160;</td>
          <td class="paramname"><em>t</em></td><td>)</td>
          <td> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the discount factor for the given date calculating it from the zero yield. </p>

<p>Implements <a class="el" href="class_quant_lib_1_1_yield_term_structure.html#afe73bf9ae8077e99d6edde6ea309e991">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>