File: class_quant_lib_1_1_floating_rate_bond.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 (117 lines) | stat: -rw-r--r-- 12,114 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
<!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>FloatingRateBond 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_bond.html">FloatingRateBond</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">FloatingRateBond Class Reference<div class="ingroups"><a class="el" href="group__instruments.html">Financial instruments</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::FloatingRateBond" --><!-- doxytag: inherits="QuantLib::Bond" -->
<p>floating-rate bond (possibly capped and/or floored)  
 <a href="class_quant_lib_1_1_floating_rate_bond.html#details">More...</a></p>

<p><code>#include &lt;ql/instruments/bonds/floatingratebond.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FloatingRateBond:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_floating_rate_bond__inherit__graph.png" border="0" usemap="#_floating_rate_bond_inherit__map" alt="Inheritance graph"/></div>
<map name="_floating_rate_bond_inherit__map" id="_floating_rate_bond_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_c_c_t_e_u.html" title="CCTEU" alt="" coords="36,166,100,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_bond.html" title="Base bond class." alt="" coords="43,6,93,37"/></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_bond-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="a50e7318255db90edb37d005ba9864be7"></a><!-- doxytag: member="QuantLib::FloatingRateBond::FloatingRateBond" ref="a50e7318255db90edb37d005ba9864be7" args="(Natural settlementDays, Real faceAmount, const Schedule &amp;schedule, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex, const DayCounter &amp;accrualDayCounter, 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())" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FloatingRateBond</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">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_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;accrualDayCounter, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> paymentConvention=Following, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays=Null&lt; <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> &gt;(), const std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;gearings=std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;(1, 1.0), const std::vector&lt; <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt; &amp;spreads=std::vector&lt; <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt;(1, 0.0), const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;caps=std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt;(), const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;floors=std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt;(), bool inArrears=false, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_bond.html#a58d0698e89061e76114760d78d588350">redemption</a>=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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6359baf95606fc168fe07e87912b603"></a><!-- doxytag: member="QuantLib::FloatingRateBond::FloatingRateBond" ref="ad6359baf95606fc168fe07e87912b603" args="(Natural settlementDays, Real faceAmount, const Date &amp;startDate, const Date &amp;maturityDate, Frequency couponFrequency, const Calendar &amp;calendar, const boost::shared_ptr&lt; IborIndex &gt; &amp;iborIndex, const DayCounter &amp;accrualDayCounter, BusinessDayConvention accrualConvention=Following, 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(), const Date &amp;stubDate=Date(), DateGeneration::Rule rule=DateGeneration::Backward, bool endOfMonth=false)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>FloatingRateBond</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> faceAmount, 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;maturityDate, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> couponFrequency, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;calendar, const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_ibor_index.html">IborIndex</a> &gt; &amp;iborIndex, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;accrualDayCounter, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> accrualConvention=Following, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> paymentConvention=Following, <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> fixingDays=Null&lt; <a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> &gt;(), const std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt; &amp;gearings=std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;(1, 1.0), const std::vector&lt; <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt; &amp;spreads=std::vector&lt; <a class="el" href="group__types.html#gae7427f4743503002b0c6eeeefae91a3d">Spread</a> &gt;(1, 0.0), const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;caps=std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt;(), const std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;floors=std::vector&lt; <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> &gt;(), bool inArrears=false, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_bond.html#a58d0698e89061e76114760d78d588350">redemption</a>=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>(), const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;stubDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), <a class="el" href="struct_quant_lib_1_1_date_generation.html#a11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a> rule=<a class="el" href="struct_quant_lib_1_1_date_generation.html#a11fcd51ef86118f65e603c1474377a78a67e19347f85332c3bbfd61266cecbe4e">DateGeneration::Backward</a>, bool endOfMonth=false)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>floating-rate bond (possibly capped and/or floored) </p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000017">Tests:</a></b></dt><dd>calculations are tested by checking results against cached values. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_bonds_8cpp-example.html#_a41">Bonds.cpp</a>.</dd>
</dl></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>