File: class_quant_lib_1_1_floating_rate_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 (235 lines) | stat: -rw-r--r-- 24,733 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!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>FloatingRateCoupon 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_floating_rate_coupon.html">FloatingRateCoupon</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">FloatingRateCoupon Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::FloatingRateCoupon" --><!-- doxytag: inherits="QuantLib::Coupon,QuantLib::Observer" -->
<p>base floating-rate coupon class  
 <a href="class_quant_lib_1_1_floating_rate_coupon.html#details">More...</a></p>

<p><code>#include &lt;ql/cashflows/floatingratecoupon.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FloatingRateCoupon:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_floating_rate_coupon__inherit__graph.png" border="0" usemap="#_floating_rate_coupon_inherit__map" alt="Inheritance graph"/></div>
<map name="_floating_rate_coupon_inherit__map" id="_floating_rate_coupon_inherit__map">
<area shape="rect" id="node7" href="class_quant_lib_1_1_average_b_m_a_coupon.html" title="Average BMA coupon." alt="" coords="328,5,469,35"/><area shape="rect" id="node9" href="class_quant_lib_1_1_capped_floored_coupon.html" title="Capped and/or floored floating&#45;rate coupon." alt="" coords="323,58,475,89"/><area shape="rect" id="node11" href="class_quant_lib_1_1_cms_coupon.html" title="CMS coupon class." alt="" coords="352,111,445,142"/><area shape="rect" id="node13" href="class_quant_lib_1_1_digital_coupon.html" title="Digital&#45;payoff coupon." alt="" coords="348,165,449,195"/><area shape="rect" id="node15" href="class_quant_lib_1_1_ibor_coupon.html" title="Coupon paying a Libor&#45;type index" alt="" coords="355,218,443,249"/><area shape="rect" id="node17" href="class_quant_lib_1_1_overnight_indexed_coupon.html" title="overnight coupon" alt="" coords="315,271,483,302"/><area shape="rect" id="node2" href="class_quant_lib_1_1_coupon.html" title="coupon accruing over a fixed period" alt="" coords="9,111,76,142"/><area shape="rect" id="node4" href="class_quant_lib_1_1_observer.html" title="Object that gets notified when a given observable changes." alt="" coords="5,165,80,195"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_floating_rate_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="ab89801171c9400f3164ba182e21192d4"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::FloatingRateCoupon" ref="ab89801171c9400f3164ba182e21192d4" args="(const Date &amp;paymentDate, Real nominal, const Date &amp;startDate, const Date &amp;endDate, Natural fixingDays, const boost::shared_ptr&lt; InterestRateIndex &gt; &amp;index, Real gearing=1.0, Spread spread=0.0, const Date &amp;refPeriodStart=Date(), const Date &amp;refPeriodEnd=Date(), const DayCounter &amp;dayCounter=DayCounter(), bool isInArrears=false)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FloatingRateCoupon</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, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a525a1bb58e63aa211a97c570b1aafc72">fixingDays</a>, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_interest_rate_index.html">InterestRateIndex</a> &gt; &amp;<a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a3abd7ea3a1e190b4a16ba6cdb32aa6b5">index</a>, <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>(), bool <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ab847c12bc9de50d7209aae33a4fa1c13">isInArrears</a>=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade8776ea16ef3f56f7b96afae4135186"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::setPricer" ref="ade8776ea16ef3f56f7b96afae4135186" args="(const boost::shared_ptr&lt; FloatingRateCouponPricer &gt; &amp;)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setPricer</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_floating_rate_coupon_pricer.html">FloatingRateCouponPricer</a> &gt; &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aafc293967ad3568fd5b8a6f38016898c"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::pricer" ref="aafc293967ad3568fd5b8a6f38016898c" args="() const " -->
boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_floating_rate_coupon_pricer.html">FloatingRateCouponPricer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>pricer</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">CashFlow interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a1d4d65b7a73a47647d5355ba4372948e">amount</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the amount of the cash flow  <a href="#a1d4d65b7a73a47647d5355ba4372948e"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Coupon interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b4bfa298dfe61af7cd976b87fc7fd22"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::rate" ref="a5b4bfa298dfe61af7cd976b87fc7fd22" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a5b4bfa298dfe61af7cd976b87fc7fd22">rate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">accrued rate <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad88cf27f1c994a91f4f2ba821bbb6f8b"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::price" ref="ad88cf27f1c994a91f4f2ba821bbb6f8b" args="(const Handle&lt; YieldTermStructure &gt; &amp;discountingCurve) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>price</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_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;discountingCurve) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac147d63df367bbe5282b76b1f98cb9be"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::dayCounter" ref="ac147d63df367bbe5282b76b1f98cb9be" args="() const " -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">day counter for accrual calculation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc435be6b06dfaeefc8f8ea1d5cfb993"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::accruedAmount" ref="adc435be6b06dfaeefc8f8ea1d5cfb993" args="(const Date &amp;) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#adc435be6b06dfaeefc8f8ea1d5cfb993">accruedAmount</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">accrued amount at the given date <br/></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="a3abd7ea3a1e190b4a16ba6cdb32aa6b5"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::index" ref="a3abd7ea3a1e190b4a16ba6cdb32aa6b5" args="() const " -->
const boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_interest_rate_index.html">InterestRateIndex</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a3abd7ea3a1e190b4a16ba6cdb32aa6b5">index</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">floating index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a525a1bb58e63aa211a97c570b1aafc72"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::fixingDays" ref="a525a1bb58e63aa211a97c570b1aafc72" args="() const " -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a525a1bb58e63aa211a97c570b1aafc72">fixingDays</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixing days <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1b6485ac61fa2e97bdfc38fe97044ff"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::fixingDate" ref="ac1b6485ac61fa2e97bdfc38fe97044ff" args="() const " -->
virtual <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_floating_rate_coupon.html#ac1b6485ac61fa2e97bdfc38fe97044ff">fixingDate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixing date <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f952b048e0a0ccbf2f0d6ffa3aa1832"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::gearing" ref="a0f952b048e0a0ccbf2f0d6ffa3aa1832" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a0f952b048e0a0ccbf2f0d6ffa3aa1832">gearing</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">index gearing, i.e. multiplicative coefficient for the index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7a3e2124c58cf10df93a8def9a2fafb"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::spread" ref="ad7a3e2124c58cf10df93a8def9a2fafb" args="() const " -->
<a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ad7a3e2124c58cf10df93a8def9a2fafb">spread</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">spread paid over the fixing of the underlying index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb75c00a042f794562147c2a5f81b08a"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::indexFixing" ref="abb75c00a042f794562147c2a5f81b08a" args="() const " -->
virtual <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#abb75c00a042f794562147c2a5f81b08a">indexFixing</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixing of the underlying index <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1105a85aa265385c18ae0e0a180b322e"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::convexityAdjustment" ref="a1105a85aa265385c18ae0e0a180b322e" args="() const " -->
virtual <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a1105a85aa265385c18ae0e0a180b322e">convexityAdjustment</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">convexity adjustment <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fc865a7893694a17491eca24f7df3a0"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::adjustedFixing" ref="a3fc865a7893694a17491eca24f7df3a0" args="() const " -->
virtual <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a3fc865a7893694a17491eca24f7df3a0">adjustedFixing</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">convexity-adjusted fixing <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab847c12bc9de50d7209aae33a4fa1c13"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::isInArrears" ref="ab847c12bc9de50d7209aae33a4fa1c13" args="() const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ab847c12bc9de50d7209aae33a4fa1c13">isInArrears</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">whether or not the coupon fixes in arrears <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Observer interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ac5c54df7ed3b930268c8d7752c101725">update</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::FloatingRateCoupon::accept" ref="a1d7eaf2f5dccce1c7781b54d64ba4a07" args="(AcyclicVisitor &amp;)" -->
virtual 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>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a119ba767531cbaa8a9eb9e1b9d5bac72"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::convexityAdjustmentImpl" ref="a119ba767531cbaa8a9eb9e1b9d5bac72" args="(Rate fixing) const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a119ba767531cbaa8a9eb9e1b9d5bac72">convexityAdjustmentImpl</a> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> fixing) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">convexity adjustment for the given index fixing <br/></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="ab36c19ec4146edfb3995d21524eec75a"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::index_" ref="ab36c19ec4146edfb3995d21524eec75a" args="" -->
boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_interest_rate_index.html">InterestRateIndex</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>index_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76c6c2d60ef1370e20bdf40a0e0ca642"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::dayCounter_" ref="a76c6c2d60ef1370e20bdf40a0e0ca642" args="" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dayCounter_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b5758dc357368c9bcb7920c66084351"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::fixingDays_" ref="a7b5758dc357368c9bcb7920c66084351" args="" -->
<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fixingDays_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac49985ed0b7d726bb87fe57577cd6d3d"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::gearing_" ref="ac49985ed0b7d726bb87fe57577cd6d3d" args="" -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>gearing_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6db15cb8f4db71dbdd282eb1a4a9bcd"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::spread_" ref="aa6db15cb8f4db71dbdd282eb1a4a9bcd" args="" -->
<a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a>&#160;</td><td class="memItemRight" valign="bottom"><b>spread_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25f8da0f6e04b43219b0a3adc3b546a2"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::isInArrears_" ref="a25f8da0f6e04b43219b0a3adc3b546a2" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isInArrears_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b075e34ab824af88d259d676650670a"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::pricer_" ref="a3b075e34ab824af88d259d676650670a" args="" -->
boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_floating_rate_coupon_pricer.html">FloatingRateCouponPricer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>pricer_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>base floating-rate coupon class </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1d4d65b7a73a47647d5355ba4372948e"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::amount" ref="a1d4d65b7a73a47647d5355ba4372948e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a1d4d65b7a73a47647d5355ba4372948e">amount</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>returns the amount of the cash flow </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The amount is not discounted, i.e., it is the actual amount paid at the cash flow date. </dd></dl>

<p>Implements <a class="el" href="class_quant_lib_1_1_cash_flow.html#a9b47a18fd731fee50de8227ea00f85ca">CashFlow</a>.</p>

</div>
</div>
<a class="anchor" id="ac5c54df7ed3b930268c8d7752c101725"></a><!-- doxytag: member="QuantLib::FloatingRateCoupon::update" ref="ac5c54df7ed3b930268c8d7752c101725" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#ac5c54df7ed3b930268c8d7752c101725">update</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes. </p>

<p>Implements <a class="el" href="class_quant_lib_1_1_observer.html#a99b02345a8a15d3c5ea2844a2253f510">Observer</a>.</p>

<p>Reimplemented in <a class="el" href="class_quant_lib_1_1_digital_coupon.html#ac5c54df7ed3b930268c8d7752c101725">DigitalCoupon</a>, and <a class="el" href="class_quant_lib_1_1_capped_floored_coupon.html#ac5c54df7ed3b930268c8d7752c101725">CappedFlooredCoupon</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>