File: class_quant_lib_1_1_fra_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 (136 lines) | stat: -rw-r--r-- 13,955 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
<!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>FraRateHelper 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_fra_rate_helper.html">FraRateHelper</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">FraRateHelper Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::FraRateHelper" --><!-- doxytag: inherits="QuantLib::RelativeDateBootstrapHelper" -->
<p>Rate helper for bootstrapping over FRA rates.  
 <a href="class_quant_lib_1_1_fra_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 FraRateHelper:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_fra_rate_helper__inherit__graph.png" border="0" usemap="#_fra_rate_helper_inherit__map" alt="Inheritance graph"/></div>
<map name="_fra_rate_helper_inherit__map" id="_fra_rate_helper_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_relative_date_bootstrap_helper.html" title="Bootstrap helper with date schedule relative to global evaluation date." alt="" coords="5,6,165,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_fra_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="a66221e6086a9b142f49030b77f7c2ca3"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="a66221e6086a9b142f49030b77f7c2ca3" args="(const Handle&lt; Quote &gt; &amp;rate, Natural monthsToStart, Natural monthsToEnd, Natural fixingDays, const Calendar &amp;calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</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;rate, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> monthsToStart, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> monthsToEnd, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays, 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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2b64ff011f3d383cd8cf31432668b8a"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="ad2b64ff011f3d383cd8cf31432668b8a" args="(Rate rate, Natural monthsToStart, Natural monthsToEnd, Natural fixingDays, const Calendar &amp;calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> rate, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> monthsToStart, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> monthsToEnd, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays, 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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab83b7e2e5e04baf2cad4e588655e6534"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="ab83b7e2e5e04baf2cad4e588655e6534" args="(const Handle&lt; Quote &gt; &amp;rate, Natural monthsToStart, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</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;rate, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> monthsToStart, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc21370f70fd544ed50a948eeca5b699"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="abc21370f70fd544ed50a948eeca5b699" args="(Rate rate, Natural monthsToStart, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> rate, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> monthsToStart, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabd53b96a42356220361b2d3d140e9c0"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="aabd53b96a42356220361b2d3d140e9c0" args="(const Handle&lt; Quote &gt; &amp;rate, Period periodToStart, Natural lengthInMonths, Natural fixingDays, const Calendar &amp;calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</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;rate, <a class="el" href="class_quant_lib_1_1_period.html">Period</a> periodToStart, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> lengthInMonths, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays, 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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab18f9167e128b8833826c057478219cd"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="ab18f9167e128b8833826c057478219cd" args="(Rate rate, Period periodToStart, Natural lengthInMonths, Natural fixingDays, const Calendar &amp;calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> rate, <a class="el" href="class_quant_lib_1_1_period.html">Period</a> periodToStart, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> lengthInMonths, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays, 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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7effed1c9e6057620d81953f5ea6aeac"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="a7effed1c9e6057620d81953f5ea6aeac" args="(const Handle&lt; Quote &gt; &amp;rate, Period periodToStart, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</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;rate, <a class="el" href="class_quant_lib_1_1_period.html">Period</a> periodToStart, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa19fc58190e432b99bb3274e47d1af1"></a><!-- doxytag: member="QuantLib::FraRateHelper::FraRateHelper" ref="aaa19fc58190e432b99bb3274e47d1af1" args="(Rate rate, Period periodToStart, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FraRateHelper</b> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> rate, <a class="el" href="class_quant_lib_1_1_period.html">Period</a> periodToStart, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex)</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::FraRateHelper::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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="a128a17ae0d2d2b95a63f9c3f49d44c31"></a><!-- doxytag: member="QuantLib::FraRateHelper::setTermStructure" ref="a128a17ae0d2d2b95a63f9c3f49d44c31" args="(YieldTermStructure *)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setTermStructure</b> (<a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> *)</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::FraRateHelper::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 FRA rates. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_f_r_a_8cpp-example.html#_a12">FRA.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#_a17">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>