File: class_quant_lib_1_1_futures_rate_helper.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 (133 lines) | stat: -rw-r--r-- 13,275 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
<!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>FuturesRateHelper 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_futures_rate_helper.html">FuturesRateHelper</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">FuturesRateHelper Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::FuturesRateHelper" --><!-- doxytag: inherits="QuantLib::BootstrapHelper" -->
<p>Rate helper for bootstrapping over <a class="el" href="class_quant_lib_1_1_ibor_index.html" title="base class for Inter-Bank-Offered-Rate indexes (e.g. Libor, etc.)">IborIndex</a> futures prices.  
 <a href="class_quant_lib_1_1_futures_rate_helper.html#details">More...</a></p>

<p><code>#include &lt;ql/termstructures/yield/ratehelpers.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FuturesRateHelper:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_futures_rate_helper__inherit__graph.png" border="0" usemap="#_futures_rate_helper_inherit__map" alt="Inheritance graph"/></div>
<map name="_futures_rate_helper_inherit__map" id="_futures_rate_helper_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_bootstrap_helper.html" title="Base helper class for bootstrapping." alt="" coords="27,6,112,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_futures_rate_helper-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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8f8fc7fd687e1f205089964f22cfc2e"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::FuturesRateHelper" ref="af8f8fc7fd687e1f205089964f22cfc2e" args="(const Handle&lt; Quote &gt; &amp;price, const Date &amp;immDate, Natural lengthInMonths, const Calendar &amp;calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter, const Handle&lt; Quote &gt; &amp;convexityAdjustment=Handle&lt; Quote &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FuturesRateHelper</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;price, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;immDate, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> lengthInMonths, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;calendar, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> convention, bool endOfMonth, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, 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;convexityAdjustment=<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;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2781d775af2d85d4bf3a18edfad17b7d"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::FuturesRateHelper" ref="a2781d775af2d85d4bf3a18edfad17b7d" args="(Real price, const Date &amp;immDate, Natural lengthInMonths, const Calendar &amp;calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter, Rate convexityAdjustment=0.0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FuturesRateHelper</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> price, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;immDate, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> lengthInMonths, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;calendar, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> convention, bool endOfMonth, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> convexityAdjustment=0.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a92c1c42e0caf366a6a28e06feacbc1"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::FuturesRateHelper" ref="a6a92c1c42e0caf366a6a28e06feacbc1" args="(const Handle&lt; Quote &gt; &amp;price, const Date &amp;immStartDate, const Date &amp;endDate, const DayCounter &amp;dayCounter, const Handle&lt; Quote &gt; &amp;convexityAdjustment=Handle&lt; Quote &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FuturesRateHelper</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;price, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;immStartDate, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;endDate, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, 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;convexityAdjustment=<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;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c5531480661d184d5be5601856b496f"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::FuturesRateHelper" ref="a3c5531480661d184d5be5601856b496f" args="(Real price, const Date &amp;immStartDate, const Date &amp;endDate, const DayCounter &amp;dayCounter, Rate convexityAdjustment=0.0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FuturesRateHelper</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> price, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;immStartDate, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;endDate, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> convexityAdjustment=0.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ab1e5812cb4e4073ba5496e3e9a8217"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::FuturesRateHelper" ref="a3ab1e5812cb4e4073ba5496e3e9a8217" args="(const Handle&lt; Quote &gt; &amp;price, const Date &amp;immDate, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex, const Handle&lt; Quote &gt; &amp;convexityAdjustment=Handle&lt; Quote &gt;())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FuturesRateHelper</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;price, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;immDate, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex, 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;convexityAdjustment=<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;())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22f486b9caa33944136b676a520072ee"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::FuturesRateHelper" ref="a22f486b9caa33944136b676a520072ee" args="(Real price, const Date &amp;immDate, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex, Rate convexityAdjustment=0.0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FuturesRateHelper</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> price, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;immDate, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> convexityAdjustment=0.0)</td></tr>
<tr><td colspan="2"><div class="groupHeader">RateHelper interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c69887bf51d43666aa7d5edfe124c0a"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::impliedQuote" ref="a9c69887bf51d43666aa7d5edfe124c0a" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>impliedQuote</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">FuturesRateHelper inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcf6adb1180a55c010c9e3ec3ce691bb"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::convexityAdjustment" ref="afcf6adb1180a55c010c9e3ec3ce691bb" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>convexityAdjustment</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d7eaf2f5dccce1c7781b54d64ba4a07"></a><!-- doxytag: member="QuantLib::FuturesRateHelper::accept" ref="a1d7eaf2f5dccce1c7781b54d64ba4a07" args="(AcyclicVisitor &amp;)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &amp;)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Rate helper for bootstrapping over <a class="el" href="class_quant_lib_1_1_ibor_index.html" title="base class for Inter-Bank-Offered-Rate indexes (e.g. Libor, etc.)">IborIndex</a> futures prices. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="swapvaluation_8cpp-example.html#_a19">swapvaluation.cpp</a>.</dd>
</dl></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>