File: class_quant_lib_1_1_overnight_indexed_swap_index.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 (149 lines) | stat: -rw-r--r-- 8,886 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
<!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>OvernightIndexedSwapIndex 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_overnight_indexed_swap_index.html">OvernightIndexedSwapIndex</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">OvernightIndexedSwapIndex Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::OvernightIndexedSwapIndex" --><!-- doxytag: inherits="QuantLib::SwapIndex" -->
<p>base class for overnight indexed swap indexes  
 <a href="class_quant_lib_1_1_overnight_indexed_swap_index.html#details">More...</a></p>

<p><code>#include &lt;ql/indexes/swapindex.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OvernightIndexedSwapIndex:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_overnight_indexed_swap_index__inherit__graph.png" border="0" usemap="#_overnight_indexed_swap_index_inherit__map" alt="Inheritance graph"/></div>
<map name="_overnight_indexed_swap_index_inherit__map" id="_overnight_indexed_swap_index_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_swap_index.html" title="base class for swap&#45;rate indexes" alt="" coords="56,6,141,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_overnight_indexed_swap_index-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="ac558cbb6a787700e36416e77e0ebb2f4"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwapIndex::OvernightIndexedSwapIndex" ref="ac558cbb6a787700e36416e77e0ebb2f4" args="(const std::string &amp;familyName, const Period &amp;tenor, Natural settlementDays, Currency currency, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>OvernightIndexedSwapIndex</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#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> currency, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2658cae9d72d328e8348656b07d8840"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwapIndex::overnightIndex" ref="ac2658cae9d72d328e8348656b07d8840" args="() const " -->
boost::shared_ptr&lt; OvernightIndex &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>overnightIndex</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_overnight_indexed_swap.html">OvernightIndexedSwap</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_overnight_indexed_swap_index.html#a3c9a90446e2ee0b8cafbf57b9f4c671b">underlyingSwap</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;fixingDate) const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a692e32fbdb1ea4abf8e1fd5620a699fa"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwapIndex::overnightIndex_" ref="a692e32fbdb1ea4abf8e1fd5620a699fa" args="" -->
boost::shared_ptr&lt; OvernightIndex &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>overnightIndex_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa73ea62fd6c5460fe045c8fc6bb4d5b5"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwapIndex::lastSwap_" ref="aa73ea62fd6c5460fe045c8fc6bb4d5b5" args="" -->
boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_overnight_indexed_swap.html">OvernightIndexedSwap</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>lastSwap_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebda2948141a2f9bf4e188512541f885"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwapIndex::lastFixingDate_" ref="aebda2948141a2f9bf4e188512541f885" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><b>lastFixingDate_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>base class for overnight indexed swap indexes </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3c9a90446e2ee0b8cafbf57b9f4c671b"></a><!-- doxytag: member="QuantLib::OvernightIndexedSwapIndex::underlyingSwap" ref="a3c9a90446e2ee0b8cafbf57b9f4c671b" args="(const Date &amp;fixingDate) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boost::shared_ptr&lt;<a class="el" href="class_quant_lib_1_1_overnight_indexed_swap.html">OvernightIndexedSwap</a>&gt; <a class="el" href="class_quant_lib_1_1_overnight_indexed_swap_index.html#a3c9a90446e2ee0b8cafbf57b9f4c671b">underlyingSwap</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td>
          <td class="paramname"><em>fixingDate</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000044">Warning:</a></b></dt><dd>Relinking the term structure underlying the index will not have effect on the returned swap. </dd></dl>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_swap_index.html#afccaabbaca855e9e0b6a82e88eb59551">SwapIndex</a>.</p>

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