File: class_quant_lib_1_1_futures_conv_adjustment_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 (165 lines) | stat: -rw-r--r-- 13,596 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
<!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: FuturesConvAdjustmentQuote 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_futures_conv_adjustment_quote.html">FuturesConvAdjustmentQuote</a></div>
<h1>FuturesConvAdjustmentQuote Class Reference</h1><!-- doxytag: class="QuantLib::FuturesConvAdjustmentQuote" --><!-- doxytag: inherits="QuantLib::Quote,QuantLib::Observer" --><code>#include &lt;ql/quotes/futuresconvadjustmentquote.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for FuturesConvAdjustmentQuote:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_futures_conv_adjustment_quote__inherit__graph.png" border="0" usemap="#_futures_conv_adjustment_quote__inherit__map" alt="Inheritance graph"></center>
<map name="_futures_conv_adjustment_quote__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_quote.html" title="purely virtual base class for market observables" alt="" coords="37,7,99,33"><area shape="rect" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="123,7,203,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_futures_conv_adjustment_quote-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
quote for the futures-convexity adjustment of an index <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="74556d262354726db58e8cb0118fd360"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::FuturesConvAdjustmentQuote" ref="74556d262354726db58e8cb0118fd360" args="(const boost::shared_ptr&lt; IborIndex &gt; &amp;index, const Date &amp;futuresDate, const Handle&lt; Quote &gt; &amp;futuresQuote, const Handle&lt; Quote &gt; &amp;volatility, const Handle&lt; Quote &gt; &amp;meanReversion)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FuturesConvAdjustmentQuote</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;index, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;futuresDate, 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;futuresQuote, 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;volatility, 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;meanReversion)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4be7fddd8a0e04ca7303628884b95dd7"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::FuturesConvAdjustmentQuote" ref="4be7fddd8a0e04ca7303628884b95dd7" args="(const boost::shared_ptr&lt; IborIndex &gt; &amp;index, const std::string &amp;immCode, const Handle&lt; Quote &gt; &amp;futuresQuote, const Handle&lt; Quote &gt; &amp;volatility, const Handle&lt; Quote &gt; &amp;meanReversion)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FuturesConvAdjustmentQuote</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;index, const std::string &amp;immCode, 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;futuresQuote, 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;volatility, 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;meanReversion)</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_futures_conv_adjustment_quote.html#c5c54df7ed3b930268c8d7752c101725">update</a> ()</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::FuturesConvAdjustmentQuote::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_futures_conv_adjustment_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::FuturesConvAdjustmentQuote::isValid" ref="ac1b70a2ed67ead038c4d3f5ac4d8a81" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_futures_conv_adjustment_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">Inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="07eb681278aea3f0d6a5e66f3403ab56"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::futuresValue" ref="07eb681278aea3f0d6a5e66f3403ab56" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>futuresValue</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9421e902ef410ac829bb244e14b4f81b"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::volatility" ref="9421e902ef410ac829bb244e14b4f81b" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>volatility</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c89093abfeb25762659fbc97a854ec3"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::meanReversion" ref="7c89093abfeb25762659fbc97a854ec3" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>meanReversion</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a93c5c7968992525a9492f57af367a66"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::immDate" ref="a93c5c7968992525a9492f57af367a66" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>immDate</b> () 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="28c827de4ff4b301f3132bfb1cfb0903"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::dc_" ref="28c827de4ff4b301f3132bfb1cfb0903" args="" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>dc_</b></td></tr>

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

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

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71fd0def8f15b04f5c1b0f63043a2d3c"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::futuresQuote_" ref="71fd0def8f15b04f5c1b0f63043a2d3c" 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>futuresQuote_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14cc04bf8608e1205f4796cbb54fd7f5"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::volatility_" ref="14cc04bf8608e1205f4796cbb54fd7f5" 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>volatility_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b50f8924eff549cb145d2ced86b9749"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::meanReversion_" ref="2b50f8924eff549cb145d2ced86b9749" 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>meanReversion_</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::FuturesConvAdjustmentQuote::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>Implements <a class="el" href="class_quant_lib_1_1_observer.html#99b02345a8a15d3c5ea2844a2253f510">Observer</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>