File: struct_quant_lib_1_1_date_generation.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 (160 lines) | stat: -rw-r--r-- 7,978 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
<!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: DateGeneration Struct 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="struct_quant_lib_1_1_date_generation.html">DateGeneration</a></div>
<h1>DateGeneration Struct Reference<br>
<small>
[<a class="el" href="group__datetime.html">Date and time calculations</a>]</small>
</h1><!-- doxytag: class="QuantLib::DateGeneration" --><code>#include &lt;ql/time/dategenerationrule.hpp&gt;</code>
<p>

<p>
<a href="struct_quant_lib_1_1_date_generation-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Date-generation rule. 
<p>
These conventions specify the rule used to generate dates in a <a class="el" href="class_quant_lib_1_1_schedule.html" title="Payment schedule.">Schedule</a>. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">Rule</a> { <a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a7867e19347f85332c3bbfd61266cecbe4e">Backward</a>, 
<a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78e204c9c3e62b1e9a6b60e40cd05256c5">Forward</a>, 
<a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78b9f6920de535f04ccfe34d670fa2c8a8">Zero</a>, 
<a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78c8d8da6652fd8ffa5e27e779518e414e">ThirdWednesday</a>
 }</td></tr>

<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_quant_lib_1_1_date_generation.html#37ee623eedc42fca85cd00bb7f9b78ae">operator&lt;&lt;</a> (std::ostream &amp;, <a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a>)</td></tr>

</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="11fcd51ef86118f65e603c1474377a78"></a><!-- doxytag: member="QuantLib::DateGeneration::Rule" ref="11fcd51ef86118f65e603c1474377a78" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">Rule</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="11fcd51ef86118f65e603c1474377a7867e19347f85332c3bbfd61266cecbe4e"></a><!-- doxytag: member="Backward" ref="11fcd51ef86118f65e603c1474377a7867e19347f85332c3bbfd61266cecbe4e" args="" -->Backward</em>&nbsp;</td><td>
Backward from termination date to effective date. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="11fcd51ef86118f65e603c1474377a78e204c9c3e62b1e9a6b60e40cd05256c5"></a><!-- doxytag: member="Forward" ref="11fcd51ef86118f65e603c1474377a78e204c9c3e62b1e9a6b60e40cd05256c5" args="" -->Forward</em>&nbsp;</td><td>
<a class="el" href="class_quant_lib_1_1_forward.html" title="Abstract base forward class.">Forward</a> from effective date to termination date. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="11fcd51ef86118f65e603c1474377a78b9f6920de535f04ccfe34d670fa2c8a8"></a><!-- doxytag: member="Zero" ref="11fcd51ef86118f65e603c1474377a78b9f6920de535f04ccfe34d670fa2c8a8" args="" -->Zero</em>&nbsp;</td><td>
No intermediate dates between effective date and termination date. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="11fcd51ef86118f65e603c1474377a78c8d8da6652fd8ffa5e27e779518e414e"></a><!-- doxytag: member="ThirdWednesday" ref="11fcd51ef86118f65e603c1474377a78c8d8da6652fd8ffa5e27e779518e414e" args="" -->ThirdWednesday</em>&nbsp;</td><td>
All dates but effective date and termination date are taken to be on the third wednesday of their month </td></tr>
</table>
</dl>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="37ee623eedc42fca85cd00bb7f9b78ae"></a><!-- doxytag: member="QuantLib::DateGeneration::operator&lt;&lt;" ref="37ee623eedc42fca85cd00bb7f9b78ae" args="(std::ostream &amp;, DateGeneration::Rule)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt;           </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_quant_lib_1_1_date_generation.html#11fcd51ef86118f65e603c1474377a78">DateGeneration::Rule</a>&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>

</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>