File: class_quant_lib_1_1_schedule.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 (163 lines) | stat: -rw-r--r-- 15,117 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
<!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: Schedule 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_schedule.html">Schedule</a></div>
<h1>Schedule Class Reference</h1><!-- doxytag: class="QuantLib::Schedule" --><code>#include &lt;ql/time/schedule.hpp&gt;</code>
<p>

<p>
<a href="class_quant_lib_1_1_schedule-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Payment schedule. <dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_bermudan_swaption_8cpp-example.html#_a23">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#_a13">ConvertibleBonds.cpp</a>, <a class="el" href="_fitted_bond_curve_8cpp-example.html#_a17">FittedBondCurve.cpp</a>, <a class="el" href="_repo_8cpp-example.html#_a17">Repo.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#_a27">swapvaluation.cpp</a>.</dl><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Iterators</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6638a6b2e69d0d6275e474ae74e6248e"></a><!-- doxytag: member="QuantLib::Schedule::const_iterator" ref="6638a6b2e69d0d6275e474ae74e6248e" args="" -->
typedef std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt;<br>
::const_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4b02d4f1a8500fb07a551069060709f"></a><!-- doxytag: member="QuantLib::Schedule::begin" ref="a4b02d4f1a8500fb07a551069060709f" args="() const " -->
const_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="350132543d80a1c1e5be844e6d2878ea"></a><!-- doxytag: member="QuantLib::Schedule::end" ref="350132543d80a1c1e5be844e6d2878ea" args="() const " -->
const_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>end</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9811026ccee1b6de7481c37c0c781473"></a><!-- doxytag: member="QuantLib::Schedule::lower_bound" ref="9811026ccee1b6de7481c37c0c781473" args="(const Date &amp;d=Date()) const " -->
const_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>lower_bound</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;d=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>()) const </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="c3899befc230efe20405b5e456cb728b"></a><!-- doxytag: member="QuantLib::Schedule::Schedule" ref="c3899befc230efe20405b5e456cb728b" args="(const std::vector&lt; Date &gt; &amp;, const Calendar &amp;calendar=NullCalendar(), BusinessDayConvention convention=Unadjusted)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Schedule</b> (const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;calendar=<a class="el" href="class_quant_lib_1_1_null_calendar.html">NullCalendar</a>(), <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> convention=Unadjusted)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="169da9fe4da5eb4aaa84992fe3579485"></a><!-- doxytag: member="QuantLib::Schedule::Schedule" ref="169da9fe4da5eb4aaa84992fe3579485" args="(const Date &amp;effectiveDate, const Date &amp;terminationDate, const Period &amp;tenor, const Calendar &amp;calendar, BusinessDayConvention convention, BusinessDayConvention terminationDateConvention, DateGeneration::Rule rule, bool endOfMonth, const Date &amp;firstDate=Date(), const Date &amp;nextToLastDate=Date())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Schedule</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;effectiveDate, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;terminationDate, const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;tenor, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;calendar, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> convention, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> terminationDateConvention, <a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a> rule, bool endOfMonth, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;firstDate=<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;nextToLastDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>

<tr><td colspan="2"><div class="groupHeader">Date access</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d78a687cf2a391198bb3cbc08bc06cb"></a><!-- doxytag: member="QuantLib::Schedule::size" ref="9d78a687cf2a391198bb3cbc08bc06cb" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bea66c4e6c7c0c704595dc74f62928b5"></a><!-- doxytag: member="QuantLib::Schedule::operator[]" ref="bea66c4e6c7c0c704595dc74f62928b5" args="(Size i) const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8552a3b104393c179d57ae4c2a631db"></a><!-- doxytag: member="QuantLib::Schedule::at" ref="d8552a3b104393c179d57ae4c2a631db" args="(Size i) const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>at</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="85d2e0e17f5004717b41200157dd4a14"></a><!-- doxytag: member="QuantLib::Schedule::date" ref="85d2e0e17f5004717b41200157dd4a14" args="(Size i) const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>date</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51fc99caf0d0a0ba4d3f2c38c0d5d4ac"></a><!-- doxytag: member="QuantLib::Schedule::previousDate" ref="51fc99caf0d0a0ba4d3f2c38c0d5d4ac" args="(const Date &amp;refDate) const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>previousDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;refDate) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5e307fb35beca9fe67dad8cddbb205b6"></a><!-- doxytag: member="QuantLib::Schedule::nextDate" ref="5e307fb35beca9fe67dad8cddbb205b6" args="(const Date &amp;refDate) const " -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>nextDate</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;refDate) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a149d4beeac42703f37f63defbff974"></a><!-- doxytag: member="QuantLib::Schedule::dates" ref="6a149d4beeac42703f37f63defbff974" args="() const " -->
const std::vector&lt; <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>dates</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="439b40d8814b479267bf0c02db12b78c"></a><!-- doxytag: member="QuantLib::Schedule::isRegular" ref="439b40d8814b479267bf0c02db12b78c" args="(Size i) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isRegular</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i) const </td></tr>

<tr><td colspan="2"><div class="groupHeader">Other inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6e61de369e994009e36f344f99c15ad"></a><!-- doxytag: member="QuantLib::Schedule::empty" ref="c6e61de369e994009e36f344f99c15ad" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1dfea729100daaf17a5ac3b724c02556"></a><!-- doxytag: member="QuantLib::Schedule::calendar" ref="1dfea729100daaf17a5ac3b724c02556" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>calendar</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9deedb3b118e820860f37c71cd37ce15"></a><!-- doxytag: member="QuantLib::Schedule::startDate" ref="9deedb3b118e820860f37c71cd37ce15" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>startDate</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d374dd66ad92e67b93771d7bcbe96b9"></a><!-- doxytag: member="QuantLib::Schedule::endDate" ref="8d374dd66ad92e67b93771d7bcbe96b9" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>endDate</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64d90b59ffaef1de9780c3c509bb4789"></a><!-- doxytag: member="QuantLib::Schedule::tenor" ref="64d90b59ffaef1de9780c3c509bb4789" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_period.html">Period</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>tenor</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d653d6960e5abf8a835f24fd9beb685"></a><!-- doxytag: member="QuantLib::Schedule::businessDayConvention" ref="9d653d6960e5abf8a835f24fd9beb685" args="() const " -->
<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>businessDayConvention</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ff4fd27cc61edade690751ad64c9787"></a><!-- doxytag: member="QuantLib::Schedule::terminationDateBusinessDayConvention" ref="2ff4fd27cc61edade690751ad64c9787" args="() const " -->
<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>terminationDateBusinessDayConvention</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c65bb19459f2af9f74de89865036dcf"></a><!-- doxytag: member="QuantLib::Schedule::rule" ref="0c65bb19459f2af9f74de89865036dcf" args="() const " -->
<a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>rule</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4bea961a3d8f31ed8c30118ed855cc92"></a><!-- doxytag: member="QuantLib::Schedule::endOfMonth" ref="4bea961a3d8f31ed8c30118ed855cc92" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>endOfMonth</b> () const </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>