File: class_quant_lib_1_1_par_coupon.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (133 lines) | stat: -rw-r--r-- 8,083 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta name="robots" content="none">
<title>QuantLib: ParCoupon 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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_par_coupon.html">ParCoupon</a></div>
<h1>ParCoupon Class Reference</h1><!-- doxytag: class="QuantLib::ParCoupon" --><!-- doxytag: inherits="QuantLib::FloatingRateCoupon" --><code>#include &lt;ql/CashFlows/parcoupon.hpp&gt;</code>
<p>
Inheritance diagram for ParCoupon:<p><center><img src="class_quant_lib_1_1_par_coupon__inherit__graph.png" border="0" usemap="#_par_coupon__inherit__map" alt="Inheritance graph"></center>
<map name="_par_coupon__inherit__map">
<area href="class_quant_lib_1_1_short_3_01_par_coupon_01_4.html" shape="rect" coords="24,455,187,479" alt="">
<area href="class_quant_lib_1_1_floating_rate_coupon.html" shape="rect" coords="27,305,184,329" alt="">
<area href="class_quant_lib_1_1_coupon.html" shape="rect" coords="17,231,92,255" alt="">
<area href="class_quant_lib_1_1_cash_flow.html" shape="rect" coords="12,156,97,180" alt="">
<area href="class_quant_lib_1_1_event.html" shape="rect" coords="24,81,85,105" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="5,7,104,31" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="116,231,199,255" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_par_coupon-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
coupon at par on a term structure 
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000009">Warning:</a></b></dt><dd>This class does not perform any date adjustment, i.e., the start and end date passed upon construction should be already rolled to a business day. </dd></dl>

<p>
<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="a49ebbc93bba2482755e57ad12a1a452"></a><!-- doxytag: member="QuantLib::ParCoupon::ParCoupon" ref="a49ebbc93bba2482755e57ad12a1a452" args="(const Date &amp;paymentDate, const Real nominal, const Date &amp;startDate, const Date &amp;endDate, const Integer fixingDays, const boost::shared_ptr&lt; Xibor &gt; &amp;index, const Real gearing=1.0, const Spread spread=0.0, const Date &amp;refPeriodStart=Date(), const Date &amp;refPeriodEnd=Date(), const DayCounter &amp;dayCounter=DayCounter())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>ParCoupon</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;paymentDate, const <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">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 <a class="el" href="group__types.html#gb9c87440c314438e51a899a03d2442d0">Integer</a> fixingDays, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_xibor.html">Xibor</a> &gt; &amp;index, const <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> gearing=1.0, const <a class="el" href="group__types.html#ge7427f4743503002b0c6eeeefae91a3d">Spread</a> spread=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;dayCounter=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>())</td></tr>

<tr><td colspan="2"><div class="groupHeader">Coupon interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86180f4ed67efd8668e1c750fa14bc56"></a><!-- doxytag: member="QuantLib::ParCoupon::rate" ref="86180f4ed67efd8668e1c750fa14bc56" args="() const" -->
Rate&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_par_coupon.html#86180f4ed67efd8668e1c750fa14bc56">rate</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">accrued rate <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d7eaf2f5dccce1c7781b54d64ba4a07"></a><!-- doxytag: member="QuantLib::ParCoupon::accept" ref="1d7eaf2f5dccce1c7781b54d64ba4a07" args="(AcyclicVisitor &amp;)" -->
virtual void&nbsp;</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>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>