File: class_quant_lib_1_1_flat_forward.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 (171 lines) | stat: -rw-r--r-- 12,592 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
170
171
<!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: FlatForward 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_flat_forward.html">FlatForward</a></div>
<h1>FlatForward Class Reference<br>
<small>
[<a class="el" href="group__yieldtermstructures.html">Term structures</a>]</small>
</h1><!-- doxytag: class="QuantLib::FlatForward" --><!-- doxytag: inherits="QuantLib::YieldTermStructure,QuantLib::LazyObject" --><code>#include &lt;ql/termstructures/yield/flatforward.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for FlatForward:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_flat_forward__inherit__graph.png" border="0" usemap="#_flat_forward__inherit__map" alt="Inheritance graph"></center>
<map name="_flat_forward__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_yield_term_structure.html" title="Interest&#45;rate term structure." alt="" coords="5,7,149,33"><area shape="rect" href="class_quant_lib_1_1_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="173,7,267,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_flat_forward-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Flat interest-rate curve. 
<p>
<dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_bermudan_swaption_8cpp-example.html#_a12">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#_a30">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#_a22">DiscreteHedging.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#_a18">EquityOption.cpp</a>, <a class="el" href="_replication_8cpp-example.html#_a9">Replication.cpp</a>, and <a class="el" href="_repo_8cpp-example.html#_a15">Repo.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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cebbf918e5cc4852d88c40b94cea1ca7"></a><!-- doxytag: member="QuantLib::FlatForward::FlatForward" ref="cebbf918e5cc4852d88c40b94cea1ca7" args="(const Date &amp;referenceDate, const Handle&lt; Quote &gt; &amp;forward, const DayCounter &amp;dayCounter, Compounding compounding=Continuous, Frequency frequency=Annual)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FlatForward</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate, const <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; &amp;forward, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> compounding=Continuous, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency=Annual)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6004273c729a56389cd3db7780ce3cbe"></a><!-- doxytag: member="QuantLib::FlatForward::FlatForward" ref="6004273c729a56389cd3db7780ce3cbe" args="(const Date &amp;referenceDate, Rate forward, const DayCounter &amp;dayCounter, Compounding compounding=Continuous, Frequency frequency=Annual)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FlatForward</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;referenceDate, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> forward, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> compounding=Continuous, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency=Annual)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42000d1ce0e9e54047615e1f38c8644d"></a><!-- doxytag: member="QuantLib::FlatForward::FlatForward" ref="42000d1ce0e9e54047615e1f38c8644d" args="(Natural settlementDays, const Calendar &amp;calendar, const Handle&lt; Quote &gt; &amp;forward, const DayCounter &amp;dayCounter, Compounding compounding=Continuous, Frequency frequency=Annual)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FlatForward</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 <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; &amp;forward, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> compounding=Continuous, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency=Annual)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62dd9e4772f5a8a0b4964d9b1782b9df"></a><!-- doxytag: member="QuantLib::FlatForward::FlatForward" ref="62dd9e4772f5a8a0b4964d9b1782b9df" args="(Natural settlementDays, const Calendar &amp;calendar, Rate forward, const DayCounter &amp;dayCounter, Compounding compounding=Continuous, Frequency frequency=Annual)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FlatForward</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, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> forward, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a> compounding=Continuous, <a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> frequency=Annual)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6968bd096b10d7259e742fa324abade3"></a><!-- doxytag: member="QuantLib::FlatForward::compounding" ref="6968bd096b10d7259e742fa324abade3" args="() const " -->
<a class="el" href="namespace_quant_lib.html#2779d04b4839fd386b5c85bbb96aaf73">Compounding</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>compounding</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="402b415c588fd029f489b30d42076cf4"></a><!-- doxytag: member="QuantLib::FlatForward::compoundingFrequency" ref="402b415c588fd029f489b30d42076cf4" args="() const " -->
<a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>compoundingFrequency</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_flat_forward.html#02b90bbfee3ee29627939544fb59ec93">performCalculations</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74d8fc5480ca811db8332b7b30597fe9"></a><!-- doxytag: member="QuantLib::FlatForward::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"><a class="el" href="class_quant_lib_1_1_flat_forward.html#74d8fc5480ca811db8332b7b30597fe9">maxDate</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_flat_forward.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="02b90bbfee3ee29627939544fb59ec93"></a><!-- doxytag: member="QuantLib::FlatForward::performCalculations" ref="02b90bbfee3ee29627939544fb59ec93" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void performCalculations           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This method must implement any calculations which must be (re)done in order to calculate the desired results. 
<p>Implements <a class="el" href="class_quant_lib_1_1_lazy_object.html#572dbe926524786c64db01e31dba7ab8">LazyObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::FlatForward::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>