← Back to branch summary

~ubuntu-branches/ubuntu/edgy/quantlib-refman-html/edgy

« back to all changes in this revision

Viewing changes to html/class_quant_lib_1_1_rate_helper.html

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2005-05-02 22:35:36 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050502223536-yp0xshf1us9u76dn
Tags: 0.3.9-1
* New upstream release 0.3.9 announced today
* As before, re-packaged upstream file QuantLib-docs-0.3.9.html.tar.gz 
  as described in the copyright file included with the Debian package.

* debian/watch: Added watch file

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/class_quant_lib_1_1_rate_helper.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
5
<meta name="robots" content="none">
 
6
<title>QuantLib: RateHelper Class Reference</title>
 
7
<link rel="stylesheet" href="quantlib.css" type="text/css">
 
8
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
 
9
<link rel="icon" href="favicon.ico" type="image/x-icon">
 
10
</head>
 
11
<body>
 
12
 
 
13
<table summary=
 
14
"Layout table: navigation bar in the first cell, contents in the second cell"
 
15
 class="layout">
 
16
<tbody>
 
17
<tr>
 
18
<td class="navbar">
 
19
 
 
20
<div class="center">
 
21
    <img class= "addtopspace" src="QL-small.jpg"
 
22
     alt="QuantLib Logo"></div>
 
23
<h3 class="navbartitle">QuantLib 0.3.9</h3>
 
24
<div class="center">
 
25
    <a href="http://quantlib.org/">http://quantlib.org</a></div>
 
26
 
 
27
<hr>
 
28
 
 
29
<h3 class="navbartitle">Getting started</h3>
 
30
 
 
31
<ul class="navlinklist">
 
32
<li><a class="navlink" href="index.html">Introduction</a></li>
 
33
<li><a class="navlink" href="overview.html">Project overview</a></li>
 
34
<li><a class="navlink" href="where.html">Where to get QuantLib</a></li>
 
35
<li><a class="navlink" href="install.html">Installation</a></li>
 
36
<li><a class="navlink" href="config.html">Configuration</a></li>
 
37
<li><a class="navlink" href="usage.html">Usage</a></li>
 
38
<li><a class="navlink" href="faq.html">Frequently asked questions</a></li>
 
39
<li><a class="navlink" href="history.html">Version history</a></li>
 
40
<li><a class="navlink" href="resources.html">Additional resources</a></li>
 
41
<li><a class="navlink" href="group.html">The QuantLib group</a></li>
 
42
<li><a class="navlink" href="license.html">Copyright and license</a></li>
 
43
</ul>
 
44
 
 
45
<hr>
 
46
 
 
47
<h3 class="navbartitle">Reference manual</h3>
 
48
 
 
49
<ul class="navlinklist">
 
50
<li><a class="navlink" href="modules.html">Modules</a></li>
 
51
<li><a class="navlink" href="hierarchy.html">Class Hierarchy</a></li>
 
52
<li><a class="navlink" href="annotated.html">Compound List</a></li>
 
53
<li><a class="navlink" href="files.html">File List</a></li>
 
54
<li><a class="navlink" href="functions.html">Compound Members</a></li>
 
55
<li><a class="navlink" href="globals.html">File Members</a></li>
 
56
<li><a class="navlink" href="todo.html">Todo List</a></li>
 
57
<li><a class="navlink" href="bug.html">Known Bugs</a></li>
 
58
<li><a class="navlink" href="test.html">Test Suite</a></li>
 
59
<li><a class="navlink" href="deprecated.html">Deprecated Features</a></li>
 
60
<li><a class="navlink" href="examples.html">Examples</a></li>
 
61
</ul>
 
62
 
 
63
</td>
 
64
<td class="main">
 
65
<!--Doxygen-generated content-->
 
66
 
 
67
<!-- Generated by Doxygen 1.4.2 -->
 
68
<div class="nav">
 
69
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_rate_helper.html">RateHelper</a></div>
 
70
<h1>RateHelper Class Reference</h1><code>#include &lt;ql/TermStructures/ratehelpers.hpp&gt;</code>
 
71
<p>
 
72
Inheritance diagram for RateHelper:<p><center><img src="class_quant_lib_1_1_rate_helper__inherit__graph.png" border="0" usemap="#_rate_helper__inherit__map" alt="Inheritance graph"></center>
 
73
<map name="_rate_helper__inherit__map">
 
74
<area href="class_quant_lib_1_1_deposit_rate_helper.html" shape="rect" coords="8,158,141,182" alt="">
 
75
<area href="class_quant_lib_1_1_fra_rate_helper.html" shape="rect" coords="165,158,274,182" alt="">
 
76
<area href="class_quant_lib_1_1_futures_rate_helper.html" shape="rect" coords="298,158,432,182" alt="">
 
77
<area href="class_quant_lib_1_1_swap_rate_helper.html" shape="rect" coords="456,158,578,182" alt="">
 
78
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="200,9,277,33" alt="">
 
79
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="301,9,392,33" alt="">
 
80
</map>
 
81
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_rate_helper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
 
82
Base class for rate helpers. 
 
83
<p>
 
84
This class provides an abstraction for the instruments used to bootstrap a term structure. It is advised that a rate helper for an instrument contains an instance of the actual instrument class to ensure consistancy between the algorithms used during bootstrapping and later instrument pricing. This is not yet fully enforced in the available rate helpers, though - only <a class="el" href="class_quant_lib_1_1_swap_rate_helper.html">SwapRateHelper</a> contains a <a class="el" href="class_quant_lib_1_1_swap.html">Swap</a> instrument for the time being. 
 
85
<p>
 
86
<table border="0" cellpadding="0" cellspacing="0">
 
87
<tr><td></td></tr>
 
88
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
89
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="QuantLib::RateHelper::RateHelper"></a>
 
90
&nbsp;</td><td class="memItemRight" valign="bottom"><b>RateHelper</b> (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;quote)</td></tr>
 
91
 
 
92
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="QuantLib::RateHelper::RateHelper"></a>
 
93
&nbsp;</td><td class="memItemRight" valign="bottom"><b>RateHelper</b> (<a class="el" href="group__types.html#ga3">Real</a> quote)</td></tr>
 
94
 
 
95
<tr><td colspan="2"><div class="groupHeader">RateHelper interface</div></td></tr>
 
96
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="z169_0" doxytag="QuantLib::RateHelper::quoteError"></a>
 
97
<a class="el" href="group__types.html#ga3">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>quoteError</b> () const </td></tr>
 
98
 
 
99
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="z169_1" doxytag="QuantLib::RateHelper::referenceQuote"></a>
 
100
<a class="el" href="group__types.html#ga3">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>referenceQuote</b> () const </td></tr>
 
101
 
 
102
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="z169_2" doxytag="QuantLib::RateHelper::impliedQuote"></a>
 
103
virtual <a class="el" href="group__types.html#ga3">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>impliedQuote</b> () const =0</td></tr>
 
104
 
 
105
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="z169_3" doxytag="QuantLib::RateHelper::discountGuess"></a>
 
106
virtual <a class="el" href="group__types.html#ga7">DiscountFactor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>discountGuess</b> () const </td></tr>
 
107
 
 
108
<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_rate_helper.html#z169_4">setTermStructure</a> (<a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> *)</td></tr>
 
109
 
 
110
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets the term structure to be used for pricing  <a href="#z169_4"></a><br></td></tr>
 
111
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <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_rate_helper.html#z169_5">latestDate</a> () const =0</td></tr>
 
112
 
 
113
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">latest relevant date  <a href="#z169_5"></a><br></td></tr>
 
114
<tr><td colspan="2"><div class="groupHeader">Observer interface</div></td></tr>
 
115
<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_rate_helper.html#z170_0">update</a> ()</td></tr>
 
116
 
 
117
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
 
118
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p0" doxytag="QuantLib::RateHelper::quote_"></a>
 
119
<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>quote_</b></td></tr>
 
120
 
 
121
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p1" doxytag="QuantLib::RateHelper::termStructure_"></a>
 
122
<a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>termStructure_</b></td></tr>
 
123
 
 
124
</table>
 
125
<hr><h2>Member Function Documentation</h2>
 
126
<a class="anchor" name="z169_4" doxytag="QuantLib::RateHelper::setTermStructure"></a><p>
 
127
<table class="mdTable" cellpadding="2" cellspacing="0">
 
128
  <tr>
 
129
    <td class="mdRow">
 
130
      <table cellpadding="0" cellspacing="0" border="0">
 
131
        <tr>
 
132
          <td class="md" nowrap valign="top">virtual void setTermStructure           </td>
 
133
          <td class="md" valign="top">(&nbsp;</td>
 
134
          <td class="md" nowrap valign="top"><a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> *&nbsp;</td>
 
135
          <td class="mdname1" valign="top" nowrap>          </td>
 
136
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
137
          <td class="md" nowrap><code> [virtual]</code></td>
 
138
        </tr>
 
139
      </table>
 
140
    </td>
 
141
  </tr>
 
142
</table>
 
143
<table cellspacing="5" cellpadding="0" border="0">
 
144
  <tr>
 
145
    <td>
 
146
      &nbsp;
 
147
    </td>
 
148
    <td>
 
149
 
 
150
<p>
 
151
sets the term structure to be used for pricing 
 
152
<p>
 
153
<dl compact><dt><b>Warning:</b></dt><dd>Being a pointer and not a shared_ptr, the term structure is not guaranteed to remain allocated for the whole life of the rate helper. It is responsibility of the programmer to ensure that the pointer remains valid. It is advised that rate helpers be used only in term structure constructors, setting the term structure to <b>this</b>, i.e., the one being constructed. </dd></dl>
 
154
 
 
155
<p>
 
156
Reimplemented in <a class="el" href="class_quant_lib_1_1_deposit_rate_helper.html#a4">DepositRateHelper</a>, <a class="el" href="class_quant_lib_1_1_fra_rate_helper.html#a4">FraRateHelper</a>, and <a class="el" href="class_quant_lib_1_1_swap_rate_helper.html#a4">SwapRateHelper</a>.    </td>
 
157
  </tr>
 
158
</table>
 
159
<a class="anchor" name="z169_5" doxytag="QuantLib::RateHelper::latestDate"></a><p>
 
160
<table class="mdTable" cellpadding="2" cellspacing="0">
 
161
  <tr>
 
162
    <td class="mdRow">
 
163
      <table cellpadding="0" cellspacing="0" border="0">
 
164
        <tr>
 
165
          <td class="md" nowrap valign="top">virtual <a class="el" href="class_quant_lib_1_1_date.html">Date</a> latestDate           </td>
 
166
          <td class="md" valign="top">(&nbsp;</td>
 
167
          <td class="mdname1" valign="top" nowrap>          </td>
 
168
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
169
          <td class="md" nowrap> const<code> [pure virtual]</code></td>
 
170
        </tr>
 
171
      </table>
 
172
    </td>
 
173
  </tr>
 
174
</table>
 
175
<table cellspacing="5" cellpadding="0" border="0">
 
176
  <tr>
 
177
    <td>
 
178
      &nbsp;
 
179
    </td>
 
180
    <td>
 
181
 
 
182
<p>
 
183
latest relevant date 
 
184
<p>
 
185
The latest date at which discounts are needed by the helper in order to provide a quote. It does not necessarily equal the maturity of the underlying instrument. 
 
186
<p>
 
187
Implemented in <a class="el" href="class_quant_lib_1_1_deposit_rate_helper.html#a5">DepositRateHelper</a>, <a class="el" href="class_quant_lib_1_1_fra_rate_helper.html#a5">FraRateHelper</a>, <a class="el" href="class_quant_lib_1_1_futures_rate_helper.html#a5">FuturesRateHelper</a>, and <a class="el" href="class_quant_lib_1_1_swap_rate_helper.html#a3">SwapRateHelper</a>.    </td>
 
188
  </tr>
 
189
</table>
 
190
<a class="anchor" name="z170_0" doxytag="QuantLib::RateHelper::update"></a><p>
 
191
<table class="mdTable" cellpadding="2" cellspacing="0">
 
192
  <tr>
 
193
    <td class="mdRow">
 
194
      <table cellpadding="0" cellspacing="0" border="0">
 
195
        <tr>
 
196
          <td class="md" nowrap valign="top">void update           </td>
 
197
          <td class="md" valign="top">(&nbsp;</td>
 
198
          <td class="mdname1" valign="top" nowrap>          </td>
 
199
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
200
          <td class="md" nowrap><code> [virtual]</code></td>
 
201
        </tr>
 
202
      </table>
 
203
    </td>
 
204
  </tr>
 
205
</table>
 
206
<table cellspacing="5" cellpadding="0" border="0">
 
207
  <tr>
 
208
    <td>
 
209
      &nbsp;
 
210
    </td>
 
211
    <td>
 
212
 
 
213
<p>
 
214
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. 
 
215
<p>
 
216
Implements <a class="el" href="class_quant_lib_1_1_observer.html#a6">Observer</a>.    </td>
 
217
  </tr>
 
218
</table>
 
219
 
 
220
</td>
 
221
</tr>
 
222
</tbody>
 
223
</table>
 
224
 
 
225
<hr>
 
226
 
 
227
<table align="top" width="100%">
 
228
<tr>
 
229
<td align="middle" width="33%">
 
230
<strong>QuantLib.org</strong><br>
 
231
<a href="http://quantlib.org/">
 
232
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
 
233
</a>
 
234
</td>
 
235
<td align="middle" width="33%">
 
236
<strong>Hosted by</strong><br>
 
237
<a href="http://sourceforge.net"><img src=
 
238
"sfnetlogo.png" width="88" height="31"
 
239
border="0" alt="SourceForge.net Logo"></a>
 
240
</td>
 
241
<td align="middle" width="33%">
 
242
<strong>Documentation generated by</strong><br>
 
243
<a href="http://www.doxygen.org">
 
244
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
 
245
</a></td>
 
246
</tr>
 
247
</table>
 
248
</body>
 
249
</html>