File: class_quant_lib_1_1_pricing_period.html

package info (click to toggle)
quantlib-refman-html 1.20-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 103,140 kB
  • sloc: javascript: 13,408; makefile: 35
file content (148 lines) | stat: -rw-r--r-- 11,452 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: PricingPeriod Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://quantlib.org">
       <img alt="QuantLib" src="QL-title.jpg"></a>
   <div id="projectbrief">A free/open-source library for quantitative finance</div>
   <div id="projectnumber">Reference manual - version 1.20</div>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_pricing_period.html">PricingPeriod</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_quant_lib_1_1_pricing_period-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PricingPeriod Class Reference<div class="ingroups"><a class="el" href="group__datetime.html">Date and time calculations</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Time pricingperiod described by a number of a given time unit.  
 <a href="class_quant_lib_1_1_pricing_period.html#details">More...</a></p>

<p><code>#include &lt;ql/experimental/commodities/pricingperiod.hpp&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for PricingPeriod:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_quant_lib_1_1_pricing_period__inherit__graph.png" border="0" usemap="#a_pricing_period_inherit__map" alt="Inheritance graph"/></div>
<map name="_pricing_period_inherit__map" id="a_pricing_period_inherit__map">
<area shape="rect" title="Time pricingperiod described by a number of a given time unit." alt="" coords="5,80,104,107"/>
<area shape="rect" href="class_quant_lib_1_1_date_interval.html" title="Date interval described by a number of a given time unit." alt="" coords="8,5,101,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0bbfdd8aebce3a0ef7699b865100c636"><td class="memItemLeft" align="right" valign="top"><a id="a0bbfdd8aebce3a0ef7699b865100c636"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PricingPeriod</b> (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;endDate, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;paymentDate, const <a class="el" href="class_quant_lib_1_1_quantity.html">Quantity</a> &amp;quantity)</td></tr>
<tr class="separator:a0bbfdd8aebce3a0ef7699b865100c636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e1d9d13ac3aaf20dbbbe07523b697c9"><td class="memItemLeft" align="right" valign="top"><a id="a7e1d9d13ac3aaf20dbbbe07523b697c9"></a>
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>paymentDate</b> () const</td></tr>
<tr class="separator:a7e1d9d13ac3aaf20dbbbe07523b697c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affbe15d479f12f60cb1a71728ddf697d"><td class="memItemLeft" align="right" valign="top"><a id="affbe15d479f12f60cb1a71728ddf697d"></a>
const <a class="el" href="class_quant_lib_1_1_quantity.html">Quantity</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>quantity</b> () const</td></tr>
<tr class="separator:affbe15d479f12f60cb1a71728ddf697d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_date_interval"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_date_interval')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_date_interval.html">DateInterval</a></td></tr>
<tr class="memitem:aa5cd194487771e9d789b71ffa1f36f70 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="aa5cd194487771e9d789b71ffa1f36f70"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DateInterval</b> (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;endDate)</td></tr>
<tr class="separator:aa5cd194487771e9d789b71ffa1f36f70 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af029a009f58347e8316a29e4f8c15ddb inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="af029a009f58347e8316a29e4f8c15ddb"></a>
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>startDate</b> () const</td></tr>
<tr class="separator:af029a009f58347e8316a29e4f8c15ddb inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a701ee809864290365056dc2dec289dd2 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="a701ee809864290365056dc2dec289dd2"></a>
const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>endDate</b> () const</td></tr>
<tr class="separator:a701ee809864290365056dc2dec289dd2 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37962de51870eea0ae4832d1bedf45b7 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="a37962de51870eea0ae4832d1bedf45b7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isDateBetween</b> (<a class="el" href="class_quant_lib_1_1_date.html">Date</a> date, bool includeFirst=true, bool includeLast=true) const</td></tr>
<tr class="separator:a37962de51870eea0ae4832d1bedf45b7 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b9765ad75edc0dffba6adf476441aec inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="a2b9765ad75edc0dffba6adf476441aec"></a>
<a class="el" href="class_quant_lib_1_1_date_interval.html">DateInterval</a>&#160;</td><td class="memItemRight" valign="bottom"><b>intersection</b> (const <a class="el" href="class_quant_lib_1_1_date_interval.html">DateInterval</a> &amp;di) const</td></tr>
<tr class="separator:a2b9765ad75edc0dffba6adf476441aec inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7917f3f94f005226de06abf9ce16c1c1 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="a7917f3f94f005226de06abf9ce16c1c1"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="class_quant_lib_1_1_date_interval.html">DateInterval</a> &amp;rhs) const</td></tr>
<tr class="separator:a7917f3f94f005226de06abf9ce16c1c1 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cd818133e8613857b573ad30d8886c7 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memItemLeft" align="right" valign="top"><a id="a5cd818133e8613857b573ad30d8886c7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="class_quant_lib_1_1_date_interval.html">DateInterval</a> &amp;rhs) const</td></tr>
<tr class="separator:a5cd818133e8613857b573ad30d8886c7 inherit pub_methods_class_quant_lib_1_1_date_interval"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Time pricingperiod described by a number of a given time unit. </p>
</div></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>