File: period_8hpp.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 (151 lines) | stat: -rw-r--r-- 10,257 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
<!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: ql/time/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.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 -->
<h1>ql/time/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 &lt;<a class="el" href="frequency_8hpp.html">ql/time/frequency.hpp</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="timeunit_8hpp.html">ql/time/timeunit.hpp</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="types_8hpp.html">ql/types.hpp</a>&gt;</code><br>

<p>
<div class="dynheader">
Include dependency graph for period.hpp:</div>
<div class="dynsection">
<p><center><img src="period_8hpp__incl.png" border="0" usemap="#ql/time/period.hpp_map" alt=""></center>
<map name="ql/time/period.hpp_map">
<area shape="rect" href="frequency_8hpp.html" title="Frequency enumeration." alt="" coords="5,84,165,111"><area shape="rect" href="timeunit_8hpp.html" title="TimeUnit enumeration." alt="" coords="189,84,339,111"><area shape="rect" href="types_8hpp.html" title="Custom types." alt="" coords="363,84,461,111"></map>
</div>
<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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_quant_lib.html">QuantLib</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><b>QuantLib::detail</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_period.html">Period</a></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&lt;&lt;" ref="9ab5db30f3aaf4d6d699066d526ebad8" args="(std::ostream &amp;, const long_period_holder &amp;)" -->
std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (std::ostream &amp;, const long_period_holder &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dca17a1305d61b38877a1fb893df3cfc"></a><!-- doxytag: member="period.hpp::operator&lt;&lt;" ref="dca17a1305d61b38877a1fb893df3cfc" args="(std::ostream &amp;, const short_period_holder &amp;)" -->
std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (std::ostream &amp;, const short_period_holder &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::long_period_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g21b63d20c9f70f1d56fe664a5d10932e">long_period</a> (const Period &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output periods in long format (e.g. "2 weeks")  <a href="group__manips.html#g21b63d20c9f70f1d56fe664a5d10932e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::short_period_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gfd478859146a0e3cdb97a51a4f7839a3">short_period</a> (const Period &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output periods in short format (e.g. "2w")  <a href="group__manips.html#gfd478859146a0e3cdb97a51a4f7839a3"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="0456c9ec3bb87c04a8749b55436dab07"></a><!-- doxytag: member="period.hpp::operator *" ref="0456c9ec3bb87c04a8749b55436dab07" args="(T n, TimeUnit units)" -->
template&lt;typename T&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">Period&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator *</b> (T n, TimeUnit units)</td></tr>

<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="11a0ea999c64dba1ee3ed4c38be45591"></a><!-- doxytag: member="period.hpp::operator *" ref="11a0ea999c64dba1ee3ed4c38be45591" args="(TimeUnit units, T n)" -->
template&lt;typename T&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">Period&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator *</b> (TimeUnit units, T 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 &amp;p)" -->
Period&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator-</b> (const Period &amp;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 &amp;p)" -->
Period&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator *</b> (Integer n, const Period &amp;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 &amp;p, Integer n)" -->
Period&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator *</b> (const Period &amp;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 &amp;p1, const Period &amp;p2)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const Period &amp;p1, const Period &amp;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 &amp;p1, const Period &amp;p2)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const Period &amp;p1, const Period &amp;p2)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="780be6bbec860087105ae605f33ef12f"></a><!-- doxytag: member="period.hpp::operator&gt;" ref="780be6bbec860087105ae605f33ef12f" args="(const Period &amp;p1, const Period &amp;p2)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&gt;</b> (const Period &amp;p1, const Period &amp;p2)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dd44fbc745bf453225c34eb592aed51"></a><!-- doxytag: member="period.hpp::operator&lt;=" ref="9dd44fbc745bf453225c34eb592aed51" args="(const Period &amp;p1, const Period &amp;p2)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;=</b> (const Period &amp;p1, const Period &amp;p2)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="267e28df2c93b4d3f9914023e0d8ec73"></a><!-- doxytag: member="period.hpp::operator&gt;=" ref="267e28df2c93b4d3f9914023e0d8ec73" args="(const Period &amp;p1, const Period &amp;p2)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&gt;=</b> (const Period &amp;p1, const Period &amp;p2)</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>