File: class_quant_lib_1_1_overnight_indexed_coupon.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 (134 lines) | stat: -rw-r--r-- 10,352 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
<!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>OvernightIndexedCoupon 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_coupon.html">OvernightIndexedCoupon</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">OvernightIndexedCoupon Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::OvernightIndexedCoupon" --><!-- doxytag: inherits="QuantLib::FloatingRateCoupon" -->
<p>overnight coupon  
 <a href="class_quant_lib_1_1_overnight_indexed_coupon.html#details">More...</a></p>

<p><code>#include &lt;ql/cashflows/overnightindexedcoupon.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OvernightIndexedCoupon:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_overnight_indexed_coupon__inherit__graph.png" border="0" usemap="#_overnight_indexed_coupon_inherit__map" alt="Inheritance graph"/></div>
<map name="_overnight_indexed_coupon_inherit__map" id="_overnight_indexed_coupon_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_floating_rate_coupon.html" title="base floating&#45;rate coupon class" alt="" coords="20,6,159,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_coupon-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="a5df568754bf01c78a6f0720861a6b74a"></a><!-- doxytag: member="QuantLib::OvernightIndexedCoupon::OvernightIndexedCoupon" ref="a5df568754bf01c78a6f0720861a6b74a" args="(const Date &amp;paymentDate, Real nominal, const Date &amp;startDate, const Date &amp;endDate, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex, Real gearing=1.0, Spread spread=0.0, const Date &amp;refPeriodStart=Date(), const Date &amp;refPeriodEnd=Date(), const DayCounter &amp;dayCounter=DayCounter())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>OvernightIndexedCoupon</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;paymentDate, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> nominal, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;startDate, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;endDate, const boost::shared_ptr&lt; OvernightIndex &gt; &amp;overnightIndex, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a0f952b048e0a0ccbf2f0d6ffa3aa1832">gearing</a>=1.0, <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ad7a3e2124c58cf10df93a8def9a2fafb">spread</a>=0.0, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;refPeriodStart=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;refPeriodEnd=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;<a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</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="a3ac803b91c3e929f54f9094ce1719bad"></a><!-- doxytag: member="QuantLib::OvernightIndexedCoupon::fixingDates" ref="a3ac803b91c3e929f54f9094ce1719bad" args="() const " -->
const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_overnight_indexed_coupon.html#a3ac803b91c3e929f54f9094ce1719bad">fixingDates</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixing dates for the rates to be compounded <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6474d91c55944f4922255494b9561e9"></a><!-- doxytag: member="QuantLib::OvernightIndexedCoupon::dt" ref="ac6474d91c55944f4922255494b9561e9" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_overnight_indexed_coupon.html#ac6474d91c55944f4922255494b9561e9">dt</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">accrual (compounding) periods <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a077b9a68b3d014b3e2f83fb64e1932ad"></a><!-- doxytag: member="QuantLib::OvernightIndexedCoupon::indexFixings" ref="a077b9a68b3d014b3e2f83fb64e1932ad" args="() const " -->
const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_overnight_indexed_coupon.html#a077b9a68b3d014b3e2f83fb64e1932ad">indexFixings</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixings to be compounded <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a400cf30b238cb25c1338c90cac6fd9b1"></a><!-- doxytag: member="QuantLib::OvernightIndexedCoupon::valueDates" ref="a400cf30b238cb25c1338c90cac6fd9b1" args="() const " -->
const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_overnight_indexed_coupon.html#a400cf30b238cb25c1338c90cac6fd9b1">valueDates</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">value dates for the rates to be compounded <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">FloatingRateCoupon interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8672d26ae625ac44319bf3ad4ced846e"></a><!-- doxytag: member="QuantLib::OvernightIndexedCoupon::fixingDate" ref="a8672d26ae625ac44319bf3ad4ced846e" args="() const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_overnight_indexed_coupon.html#a8672d26ae625ac44319bf3ad4ced846e">fixingDate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the date when the coupon is fully determined <br/></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::OvernightIndexedCoupon::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>overnight coupon </p>
<p>Coupon paying the compounded interest due to daily overnight fixings. </p>
</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>