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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
<!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: ql/period.hpp File 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 -->
<h1>ql/period.hpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
period- and frequency-related classes and enumerations
<p>
<p>
<code>#include <<a class="el" href="errors_8hpp.html">ql/errors.hpp</a>></code><br>
<code>#include <<a class="el" href="types_8hpp.html">ql/types.hpp</a>></code><br>
<code>#include <ostream></code><br>
<p>
Include dependency graph for period.hpp:<p><center><img src="period_8hpp__incl.png" border="0" usemap="#ql/period.hpp_map" alt=""></center>
<map name="ql/period.hpp_map">
<area href="errors_8hpp.html" shape="rect" coords="167,150,273,174" alt="">
<area href="types_8hpp.html" shape="rect" coords="167,246,273,270" alt="">
<area href="qldefines_8hpp.html" shape="rect" coords="360,246,491,270" alt="">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><b>QuantLib</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><b>QuantLib::detail</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><b>QuantLib::io</b></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_period.html">Period</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Time period described by a number of a given time unit. <a href="class_quant_lib_1_1_period.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a> { <br>
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452adad7764a2ea2518891555bd395faffb4da">NoFrequency</a> = -1,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada96be73c339468e5d0d9aed7ccc384bcc">Once</a> = 0,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada508b18014c96e2d466c12b39d7f4e426">Annual</a> = 1,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452adad1a5868a1c314bb7f6ab68e2fa182b2d">Semiannual</a> = 2,
<br>
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452adacb332c66d96dd68b145f78c14a704f5c">EveryFourthMonth</a> = 3,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452adab4fce358383d1822f7596659e00b07f7">Quarterly</a> = 4,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada91a5f14e7e96afbf6429a2549d6896e8">Bimonthly</a> = 6,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada075d775ff1bb75474c994bd94e9629f4">Monthly</a> = 12,
<br>
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada1b3b68c6c6974a8e343ea8d8b66c107f">Biweekly</a> = 26,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada39017ed07c435bd4b739cda6bf3e5a35">Weekly</a> = 52,
<a class="el" href="group__datetime.html#gg6d41db8ba0ea90d22df35889df452ada6b15f8b55b10fefe6300b2f3bf60ad78">Daily</a> = 365
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frequency of events. <a href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__datetime.html#gdd9fe45e09605eee3e4a39c8a5c4476d">TimeUnit</a> { <b>Days</b>,
<b>Weeks</b>,
<b>Months</b>,
<b>Years</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Units used to describe time periods. <br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ab5db30f3aaf4d6d699066d526ebad8"></a><!-- doxytag: member="period.hpp::operator<<" ref="9ab5db30f3aaf4d6d699066d526ebad8" args="(std::ostream &, const long_period_holder &)" -->
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &, const long_period_holder &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dca17a1305d61b38877a1fb893df3cfc"></a><!-- doxytag: member="period.hpp::operator<<" ref="dca17a1305d61b38877a1fb893df3cfc" args="(std::ostream &, const short_period_holder &)" -->
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &, const short_period_holder &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g21b63d20c9f70f1d56fe664a5d10932e"></a><!-- doxytag: member="period.hpp::long_period" ref="g21b63d20c9f70f1d56fe664a5d10932e" args="(const Period &)" -->
detail::long_period_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g21b63d20c9f70f1d56fe664a5d10932e">long_period</a> (const Period &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output periods in long format (e.g. "2 weeks") <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd478859146a0e3cdb97a51a4f7839a3"></a><!-- doxytag: member="period.hpp::short_period" ref="gfd478859146a0e3cdb97a51a4f7839a3" args="(const Period &)" -->
detail::short_period_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gfd478859146a0e3cdb97a51a4f7839a3">short_period</a> (const Period &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output periods in short format (e.g. "2w") <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2d00fb71d2418cff672fb39c90a7b45"></a><!-- doxytag: member="period.hpp::operator *" ref="e2d00fb71d2418cff672fb39c90a7b45" args="(Integer n, TimeUnit units)" -->
Period </td><td class="memItemRight" valign="bottom"><b>operator *</b> (Integer n, TimeUnit units)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c4b71dce504f6345533d84b1fbb2242"></a><!-- doxytag: member="period.hpp::operator *" ref="8c4b71dce504f6345533d84b1fbb2242" args="(TimeUnit units, Integer n)" -->
Period </td><td class="memItemRight" valign="bottom"><b>operator *</b> (TimeUnit units, Integer n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ed581464d2437b3c22965f83a79671f"></a><!-- doxytag: member="period.hpp::operator-" ref="4ed581464d2437b3c22965f83a79671f" args="(const Period &p)" -->
Period </td><td class="memItemRight" valign="bottom"><b>operator-</b> (const Period &p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a1b651428d0973b3570f445978d5918"></a><!-- doxytag: member="period.hpp::operator *" ref="2a1b651428d0973b3570f445978d5918" args="(Integer n, const Period &p)" -->
Period </td><td class="memItemRight" valign="bottom"><b>operator *</b> (Integer n, const Period &p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="24bb873cbc7eae875117336a1aa5e918"></a><!-- doxytag: member="period.hpp::operator *" ref="24bb873cbc7eae875117336a1aa5e918" args="(const Period &p, Integer n)" -->
Period </td><td class="memItemRight" valign="bottom"><b>operator *</b> (const Period &p, Integer n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31207e6c1ca6e853a41d8bf942e268b9"></a><!-- doxytag: member="period.hpp::operator==" ref="31207e6c1ca6e853a41d8bf942e268b9" args="(const Period &p1, const Period &p2)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const Period &p1, const Period &p2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b4cd3aebfbb1e76d9d8082724e25f54"></a><!-- doxytag: member="period.hpp::operator!=" ref="9b4cd3aebfbb1e76d9d8082724e25f54" args="(const Period &p1, const Period &p2)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const Period &p1, const Period &p2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="780be6bbec860087105ae605f33ef12f"></a><!-- doxytag: member="period.hpp::operator>" ref="780be6bbec860087105ae605f33ef12f" args="(const Period &p1, const Period &p2)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator></b> (const Period &p1, const Period &p2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dd44fbc745bf453225c34eb592aed51"></a><!-- doxytag: member="period.hpp::operator<=" ref="9dd44fbc745bf453225c34eb592aed51" args="(const Period &p1, const Period &p2)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator<=</b> (const Period &p1, const Period &p2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="267e28df2c93b4d3f9914023e0d8ec73"></a><!-- doxytag: member="period.hpp::operator>=" ref="267e28df2c93b4d3f9914023e0d8ec73" args="(const Period &p1, const Period &p2)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator>=</b> (const Period &p1, const Period &p2)</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>
|
