File: class_quant_lib_1_1_cms_rate_bond.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (103 lines) | stat: -rw-r--r-- 6,996 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
<!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>QuantLib: CmsRateBond 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.9.0</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="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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1_cms_rate_bond.html">CmsRateBond</a></div>
<h1>CmsRateBond Class Reference<br>
<small>
[<a class="el" href="group__instruments.html">Financial instruments</a>]</small>
</h1><!-- doxytag: class="QuantLib::CmsRateBond" --><!-- doxytag: inherits="QuantLib::Bond" --><code>#include &lt;ql/instruments/bonds/cmsratebond.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for CmsRateBond:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_cms_rate_bond__inherit__graph.png" border="0" usemap="#_cms_rate_bond__inherit__map" alt="Inheritance graph"></center>
<map name="_cms_rate_bond__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_bond.html" title="Base bond class." alt="" coords="36,7,89,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_cms_rate_bond-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
CMS-rate bond. 
<p>
<dl compact><dt><b><a class="el" href="test.html#_test000006">Tests:</a></b></dt><dd>calculations are tested by checking results against cached values. </dd></dl>
<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="7633422a0c3c58407b7d7d9a61699ea2"></a><!-- doxytag: member="QuantLib::CmsRateBond::CmsRateBond" ref="7633422a0c3c58407b7d7d9a61699ea2" args="(Natural settlementDays, Real faceAmount, const Schedule &amp;schedule, const boost::shared_ptr&lt; SwapIndex &gt; &amp;index, const DayCounter &amp;paymentDayCounter, BusinessDayConvention paymentConvention=Following, Natural fixingDays=Null&lt; Natural &gt;(), const std::vector&lt; Real &gt; &amp;gearings=std::vector&lt; Real &gt;(1, 1.0), const std::vector&lt; Spread &gt; &amp;spreads=std::vector&lt; Spread &gt;(1, 0.0), const std::vector&lt; Rate &gt; &amp;caps=std::vector&lt; Rate &gt;(), const std::vector&lt; Rate &gt; &amp;floors=std::vector&lt; Rate &gt;(), bool inArrears=false, Real redemption=100.0, const Date &amp;issueDate=Date())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>CmsRateBond</b> (<a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> faceAmount, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &amp;schedule, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_swap_index.html">SwapIndex</a> &gt; &amp;index, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;paymentDayCounter, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> paymentConvention=Following, <a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays=<a class="el" href="class_quant_lib_1_1_null.html">Null</a>&lt; <a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> &gt;(), const std::vector&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;gearings=std::vector&lt; <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;(1, 1.0), const std::vector&lt; <a class="el" href="group__types.html#ge7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt; &amp;spreads=std::vector&lt; <a class="el" href="group__types.html#ge7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt;(1, 0.0), const std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;caps=std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt;(), const std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;floors=std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt;(), bool inArrears=false, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> redemption=100.0, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;issueDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>

</table>

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>

</div>

</body>
</html>