File: class_quant_lib_1_1_ibor_index.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 (126 lines) | stat: -rw-r--r-- 10,312 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
<!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: IborIndex 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_ibor_index.html">IborIndex</a></div>
<h1>IborIndex Class Reference</h1><!-- doxytag: class="QuantLib::IborIndex" --><!-- doxytag: inherits="QuantLib::InterestRateIndex" --><code>#include &lt;ql/indexes/iborindex.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for IborIndex:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_ibor_index__inherit__graph.png" border="0" usemap="#_ibor_index__inherit__map" alt="Inheritance graph"></center>
<map name="_ibor_index__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_cdor.html" title="CDOR rate" alt="" coords="5,161,59,188"><area shape="rect" href="class_quant_lib_1_1_euribor.html" title="Euribor index" alt="" coords="83,161,149,188"><area shape="rect" href="class_quant_lib_1_1_euribor365.html" title="Actual/365 Euribor index." alt="" coords="173,161,264,188"><area shape="rect" href="class_quant_lib_1_1_e_u_r_libor.html" title="EUR LIBOR rate" alt="" coords="288,161,371,188"><area shape="rect" href="class_quant_lib_1_1_jibar.html" title="JIBAR rate" alt="" coords="395,161,443,188"><area shape="rect" href="class_quant_lib_1_1_libor.html" title="base class for all BBA LIBOR indexes but the EUR ones" alt="" coords="467,161,520,188"><area shape="rect" href="class_quant_lib_1_1_tibor.html" title="JPY TIBOR index" alt="" coords="544,161,595,188"><area shape="rect" href="class_quant_lib_1_1_t_r_libor.html" title="TRY LIBOR rate" alt="" coords="619,161,688,188"><area shape="rect" href="class_quant_lib_1_1_zibor.html" title="CHF ZIBOR rate" alt="" coords="712,161,765,188"><area shape="rect" href="class_quant_lib_1_1_interest_rate_index.html" title="base class for interest rate indexes" alt="" coords="349,7,488,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_ibor_index-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
base class for Inter-Bank-Offered-Rate indexes (e.g. Libor, etc.) <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="c4c5fa744aa616d1eef9066ce19e12d7"></a><!-- doxytag: member="QuantLib::IborIndex::IborIndex" ref="c4c5fa744aa616d1eef9066ce19e12d7" args="(const std::string &amp;familyName, const Period &amp;tenor, Natural settlementDays, const Currency &amp;currency, const Calendar &amp;fixingCalendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &amp;dayCounter, const Handle&lt; YieldTermStructure &gt; &amp;h=Handle&lt; YieldTermStructure &gt;())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>IborIndex</b> (const std::string &amp;familyName, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;tenor, <a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> &amp;currency, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;fixingCalendar, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">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_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;h=<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt;())</td></tr>

<tr><td colspan="2"><div class="groupHeader">InterestRateIndex interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c44ba2c069f4b71b92f39a7edc0d640a"></a><!-- doxytag: member="QuantLib::IborIndex::termStructure" ref="c44ba2c069f4b71b92f39a7edc0d640a" args="() const " -->
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>termStructure</b> () const </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="9d653d6960e5abf8a835f24fd9beb685"></a><!-- doxytag: member="QuantLib::IborIndex::businessDayConvention" ref="9d653d6960e5abf8a835f24fd9beb685" args="() const " -->
<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>businessDayConvention</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4bea961a3d8f31ed8c30118ed855cc92"></a><!-- doxytag: member="QuantLib::IborIndex::endOfMonth" ref="4bea961a3d8f31ed8c30118ed855cc92" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>endOfMonth</b> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader">Date calculations</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="615a330e425e4b9abceba4a56fc2664f"></a><!-- doxytag: member="QuantLib::IborIndex::maturityDate" ref="615a330e425e4b9abceba4a56fc2664f" args="(const Date &amp;valueDate) const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>maturityDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;valueDate) const </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="31402c8dcd6c83166c07900d7f440bca"></a><!-- doxytag: member="QuantLib::IborIndex::forecastFixing" ref="31402c8dcd6c83166c07900d7f440bca" args="(const Date &amp;fixingDate) const " -->
<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>forecastFixing</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;fixingDate) 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="80921adec5b2e5641608d33585ec2a17"></a><!-- doxytag: member="QuantLib::IborIndex::convention_" ref="80921adec5b2e5641608d33585ec2a17" args="" -->
<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>convention_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ccfb2e6f0d4ec3fb0789e250aa3295ca"></a><!-- doxytag: member="QuantLib::IborIndex::termStructure_" ref="ccfb2e6f0d4ec3fb0789e250aa3295ca" args="" -->
<a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>termStructure_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f9cce4f14d75f9e75dcba9a025ee764"></a><!-- doxytag: member="QuantLib::IborIndex::endOfMonth_" ref="0f9cce4f14d75f9e75dcba9a025ee764" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>endOfMonth_</b></td></tr>

</table>

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