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
|
<!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>Dividend 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_dividend.html">Dividend</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Dividend Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Dividend" --><!-- doxytag: inherits="QuantLib::CashFlow" -->
<p>Predetermined cash flow.
<a href="class_quant_lib_1_1_dividend.html#details">More...</a></p>
<p><code>#include <ql/cashflows/dividend.hpp></code></p>
<div class="dynheader">
Inheritance diagram for Dividend:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_dividend__inherit__graph.png" border="0" usemap="#_dividend_inherit__map" alt="Inheritance graph"/></div>
<map name="_dividend_inherit__map" id="_dividend_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_fixed_dividend.html" title="Predetermined cash flow." alt="" coords="5,166,109,197"/><area shape="rect" id="node7" href="class_quant_lib_1_1_fractional_dividend.html" title="Predetermined cash flow." alt="" coords="133,166,261,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_cash_flow.html" title="Base class for cash flows." alt="" coords="88,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_dividend-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="a3ce04351ecc7f83eab8f3bfaaa99f3d4"></a><!-- doxytag: member="QuantLib::Dividend::Dividend" ref="a3ce04351ecc7f83eab8f3bfaaa99f3d4" args="(const Date &date)" -->
 </td><td class="memItemRight" valign="bottom"><b>Dividend</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &<a class="el" href="class_quant_lib_1_1_dividend.html#a10f7d7687d98bfb4979aaa4c86c86a54">date</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4851910d5646519c98bb6ee48bab8648"></a><!-- doxytag: member="QuantLib::Dividend::amount" ref="a4851910d5646519c98bb6ee48bab8648" args="(Real underlying) const =0" -->
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>amount</b> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> underlying) const =0</td></tr>
<tr><td colspan="2"><div class="groupHeader">Event interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_dividend.html#a10f7d7687d98bfb4979aaa4c86c86a54">date</a> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">CashFlow interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_dividend.html#a9b47a18fd731fee50de8227ea00f85ca">amount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the amount of the cash flow <a href="#a9b47a18fd731fee50de8227ea00f85ca"></a><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="a896099363a2a409d2485c3ce9e4e4265"></a><!-- doxytag: member="QuantLib::Dividend::accept" ref="a896099363a2a409d2485c3ce9e4e4265" args="(AcyclicVisitor &)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &)</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="ae66f66b0d2874fc0d466bc1ef6dd2976"></a><!-- doxytag: member="QuantLib::Dividend::date_" ref="ae66f66b0d2874fc0d466bc1ef6dd2976" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td><td class="memItemRight" valign="bottom"><b>date_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Predetermined cash flow. </p>
<p>This cash flow pays a predetermined amount at a given date. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a10f7d7687d98bfb4979aaa4c86c86a54"></a><!-- doxytag: member="QuantLib::Dividend::date" ref="a10f7d7687d98bfb4979aaa4c86c86a54" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_date.html">Date</a> <a class="el" href="class_quant_lib_1_1_dividend.html#a10f7d7687d98bfb4979aaa4c86c86a54">date</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="note"><dt><b>Note:</b></dt><dd>This is inherited from the event class </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_cash_flow.html#ac659412fae5cc99a0fdf25f7f4b9562e">CashFlow</a>.</p>
</div>
</div>
<a class="anchor" id="a9b47a18fd731fee50de8227ea00f85ca"></a><!-- doxytag: member="QuantLib::Dividend::amount" ref="a9b47a18fd731fee50de8227ea00f85ca" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_dividend.html#a9b47a18fd731fee50de8227ea00f85ca">amount</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure 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>
<p>Implemented in <a class="el" href="class_quant_lib_1_1_fractional_dividend.html#a16b8c27249065cfd9c5a2df99c217fac">FractionalDividend</a>, and <a class="el" href="class_quant_lib_1_1_fixed_dividend.html#a16b8c27249065cfd9c5a2df99c217fac">FixedDividend</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>
|
