File: class_quant_lib_1_1_forward_swap_quote.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 (195 lines) | stat: -rw-r--r-- 13,876 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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<!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: ForwardSwapQuote 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_forward_swap_quote.html">ForwardSwapQuote</a></div>
<h1>ForwardSwapQuote Class Reference</h1><!-- doxytag: class="QuantLib::ForwardSwapQuote" --><!-- doxytag: inherits="QuantLib::Quote,QuantLib::LazyObject" --><code>#include &lt;ql/quotes/forwardswapquote.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for ForwardSwapQuote:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_forward_swap_quote__inherit__graph.png" border="0" usemap="#_forward_swap_quote__inherit__map" alt="Inheritance graph"></center>
<map name="_forward_swap_quote__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables" alt="" coords="5,7,67,33"><area shape="rect" href="class_quant_lib_1_1_lazy_object.html" title="Framework for calculation on demand and result caching." alt="" coords="91,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_forward_swap_quote-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables">Quote</a> for a forward starting swap. <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="2554b9dd0051ff3515a9960c1dcac0f9"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::ForwardSwapQuote" ref="2554b9dd0051ff3515a9960c1dcac0f9" args="(const boost::shared_ptr&lt; SwapIndex &gt; &amp;swapIndex, const Handle&lt; Quote &gt; &amp;spread, const Period &amp;fwdStart)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>ForwardSwapQuote</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_swap_index.html">SwapIndex</a> &gt; &amp;swapIndex, 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;spread, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;fwdStart)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="564ae9e6cc9c76d2d63daaf7395b7d6c"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::valueDate" ref="564ae9e6cc9c76d2d63daaf7395b7d6c" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>valueDate</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31cb634ae3717b7740c373fd6c34f1d1"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::startDate" ref="31cb634ae3717b7740c373fd6c34f1d1" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>startDate</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee260a08ccb6428c19b51ac1042641df"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::fixingDate" ref="ee260a08ccb6428c19b51ac1042641df" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>fixingDate</b> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader">Quote interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7f31cfaca49d25079e464ca462d691c"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::value" ref="b7f31cfaca49d25079e464ca462d691c" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_forward_swap_quote.html#b7f31cfaca49d25079e464ca462d691c">value</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the current value <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac1b70a2ed67ead038c4d3f5ac4d8a81"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::isValid" ref="ac1b70a2ed67ead038c4d3f5ac4d8a81" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_forward_swap_quote.html#ac1b70a2ed67ead038c4d3f5ac4d8a81">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns true if the <a class="el" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables">Quote</a> holds a valid value <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Observer interface</div></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_forward_swap_quote.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b508edbd7d439284c55178fd681adb0"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::initializeDates" ref="5b508edbd7d439284c55178fd681adb0" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>initializeDates</b> ()</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_forward_swap_quote.html#02b90bbfee3ee29627939544fb59ec93">performCalculations</a> () const </td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a0b946fc98b025f246b77d6c2751f41"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::swapIndex_" ref="3a0b946fc98b025f246b77d6c2751f41" args="" -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_swap_index.html">SwapIndex</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>swapIndex_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5caa3200880208842845075caebdb6e1"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::spread_" ref="5caa3200880208842845075caebdb6e1" args="" -->
<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;&nbsp;</td><td class="memItemRight" valign="bottom"><b>spread_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="210177f5ff56e9dd35422f0b0c83bae7"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::fwdStart_" ref="210177f5ff56e9dd35422f0b0c83bae7" args="" -->
<a class="el" href="class_quant_lib_1_1_period.html">Period</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>fwdStart_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab7be0a2ef3486101fe70ac7ba229d17"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::evaluationDate_" ref="ab7be0a2ef3486101fe70ac7ba229d17" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>evaluationDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ebe1ee9fe8c4edd97894a5caec6cf370"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::valueDate_" ref="ebe1ee9fe8c4edd97894a5caec6cf370" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>valueDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c56f0c18a8f1a3337b9f9456958e4611"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::startDate_" ref="c56f0c18a8f1a3337b9f9456958e4611" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>startDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f3d454856e688ed07ac415619cd9fda"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::fixingDate_" ref="0f3d454856e688ed07ac415619cd9fda" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>fixingDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="32ea77a274fa82ee6a3adfd66f3a8e6f"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::swap_" ref="32ea77a274fa82ee6a3adfd66f3a8e6f" args="" -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_vanilla_swap.html">VanillaSwap</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="087ee1198578dd5bffa6aa070d95551d"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::result_" ref="087ee1198578dd5bffa6aa070d95551d" args="" -->
<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>result_</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::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>
<a class="anchor" name="02b90bbfee3ee29627939544fb59ec93"></a><!-- doxytag: member="QuantLib::ForwardSwapQuote::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> [protected, 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>

</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>