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
199
200
201
|
<!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>Rounding 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="185" height="50" 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 1.2</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="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="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="examples.html">Examples</a></li>
</ul>
</div>
<div id="content">
<!--Doxygen-generated content-->
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>QuantLib</b> </li>
<li class="navelem"><a class="el" href="class_quant_lib_1_1_rounding.html">Rounding</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Rounding Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Rounding" -->
<p>basic rounding class
<a href="class_quant_lib_1_1_rounding.html#details">More...</a></p>
<p><code>#include <ql/math/rounding.hpp></code></p>
<div class="dynheader">
Inheritance diagram for Rounding:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_rounding__inherit__graph.png" border="0" usemap="#_rounding_inherit__map" alt="Inheritance graph"/></div>
<map name="_rounding_inherit__map" id="_rounding_inherit__map">
<area shape="rect" id="node3" href="class_quant_lib_1_1_ceiling_truncation.html" title="Ceiling truncation." alt="" coords="5,86,125,117"/><area shape="rect" id="node5" href="class_quant_lib_1_1_closest_rounding.html" title="Closest rounding." alt="" coords="149,86,269,117"/><area shape="rect" id="node7" href="class_quant_lib_1_1_down_rounding.html" title="Down-rounding." alt="" coords="293,86,400,117"/><area shape="rect" id="node9" href="class_quant_lib_1_1_floor_truncation.html" title="Floor truncation." alt="" coords="424,86,533,117"/><area shape="rect" id="node11" href="class_quant_lib_1_1_up_rounding.html" title="Up-rounding." alt="" coords="557,86,648,117"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_rounding-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <br/>
  <a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7ac9d3e887722f2bc482bcca9d41c512af">None</a>,
<a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7a57a7edcbc04d6175683383cad5c3e0a2">Up</a>,
<a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7abcf8c79e9a5f5f9d606fb35645a0fb27">Down</a>,
<a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7a32c94a47509871edf49d5c3936689d30">Closest</a>,
<br/>
  <a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7a94e95e4b8360855608dfad0b1f43a301">Floor</a>,
<a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7a0d419a70fa5708b3735db741f20316c9">Ceiling</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">rounding methods <a href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_rounding.html#a935bf504beb13c384b6bf2b57337b60c">Rounding</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#a935bf504beb13c384b6bf2b57337b60c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a79742b3f2854a95befbd58cf917341"></a><!-- doxytag: member="QuantLib::Rounding::Rounding" ref="a2a79742b3f2854a95befbd58cf917341" args="(Integer precision, Type type=Closest, Integer digit=5)" -->
 </td><td class="memItemRight" valign="bottom"><b>Rounding</b> (<a class="el" href="group__types.html#gab9c87440c314438e51a899a03d2442d0">Integer</a> precision, <a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> type=<a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7a32c94a47509871edf49d5c3936689d30">Closest</a>, <a class="el" href="group__types.html#gab9c87440c314438e51a899a03d2442d0">Integer</a> digit=5)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9835436c4cf8e92f0f7d8a3ed4643983"></a><!-- doxytag: member="QuantLib::Rounding::operator()" ref="a9835436c4cf8e92f0f7d8a3ed4643983" args="(Decimal value) const " -->
<a class="el" href="group__types.html#gaee215f8d421f6afcede0391fcffb5fe7">Decimal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_rounding.html#a9835436c4cf8e92f0f7d8a3ed4643983">operator()</a> (<a class="el" href="group__types.html#gaee215f8d421f6afcede0391fcffb5fe7">Decimal</a> value) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">perform rounding <br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Inspectors</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a242cddb670f123b7cf2ec6b244514c8b"></a><!-- doxytag: member="QuantLib::Rounding::precision" ref="a242cddb670f123b7cf2ec6b244514c8b" args="() const " -->
<a class="el" href="group__types.html#gab9c87440c314438e51a899a03d2442d0">Integer</a> </td><td class="memItemRight" valign="bottom"><b>precision</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbd0fa31db28593e9669c3c56711c0a7"></a><!-- doxytag: member="QuantLib::Rounding::type" ref="afbd0fa31db28593e9669c3c56711c0a7" args="() const " -->
<a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td><td class="memItemRight" valign="bottom"><b>type</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdd70a56bfd67e3da02c16706ea1898d"></a><!-- doxytag: member="QuantLib::Rounding::roundingDigit" ref="abdd70a56bfd67e3da02c16706ea1898d" args="() const " -->
<a class="el" href="group__types.html#gab9c87440c314438e51a899a03d2442d0">Integer</a> </td><td class="memItemRight" valign="bottom"><b>roundingDigit</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>basic rounding class </p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000060">Tests:</a></b></dt><dd>the correctness of the returned values is tested by checking them against known good results. </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="QuantLib::Rounding::Type" ref="a1d1cfd8ffb84e947f82999c682b666a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_quant_lib_1_1_rounding.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>rounding methods </p>
<p>The rounding methods follow the OMG specification available at <a href="ftp://ftp.omg.org/pub/docs/formal/00-06-29.pdf">ftp://ftp.omg.org/pub/docs/formal/00-06-29.pdf</a></p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000073">Warning:</a></b></dt><dd>the names of the <a class="el" href="class_quant_lib_1_1_floor.html" title="Concrete floor class.">Floor</a> and Ceiling methods might be misleading. Check the provided reference. </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7ac9d3e887722f2bc482bcca9d41c512af"></a><!-- doxytag: member="None" ref="a1d1cfd8ffb84e947f82999c682b666a7ac9d3e887722f2bc482bcca9d41c512af" args="" -->None</em> </td><td>
<p>do not round: return the number unmodified </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a57a7edcbc04d6175683383cad5c3e0a2"></a><!-- doxytag: member="Up" ref="a1d1cfd8ffb84e947f82999c682b666a7a57a7edcbc04d6175683383cad5c3e0a2" args="" -->Up</em> </td><td>
<p>the first decimal place past the precision will be rounded up. This differs from the OMG rule which rounds up only if the decimal to be rounded is greater than or equal to the rounding digit </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7abcf8c79e9a5f5f9d606fb35645a0fb27"></a><!-- doxytag: member="Down" ref="a1d1cfd8ffb84e947f82999c682b666a7abcf8c79e9a5f5f9d606fb35645a0fb27" args="" -->Down</em> </td><td>
<p>all decimal places past the precision will be truncated </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a32c94a47509871edf49d5c3936689d30"></a><!-- doxytag: member="Closest" ref="a1d1cfd8ffb84e947f82999c682b666a7a32c94a47509871edf49d5c3936689d30" args="" -->Closest</em> </td><td>
<p>the first decimal place past the precision will be rounded up if greater than or equal to the rounding digit; this corresponds to the OMG round-up rule. When the rounding digit is 5, the result will be the one closest to the original number, hence the name. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a94e95e4b8360855608dfad0b1f43a301"></a><!-- doxytag: member="Floor" ref="a1d1cfd8ffb84e947f82999c682b666a7a94e95e4b8360855608dfad0b1f43a301" args="" -->Floor</em> </td><td>
<p>positive numbers will be rounded up and negative numbers will be rounded down using the OMG round up and round down rules </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d1cfd8ffb84e947f82999c682b666a7a0d419a70fa5708b3735db741f20316c9"></a><!-- doxytag: member="Ceiling" ref="a1d1cfd8ffb84e947f82999c682b666a7a0d419a70fa5708b3735db741f20316c9" args="" -->Ceiling</em> </td><td>
<p>positive numbers will be rounded down and negative numbers will be rounded up using the OMG round up and round down rules </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a935bf504beb13c384b6bf2b57337b60c"></a><!-- doxytag: member="QuantLib::Rounding::Rounding" ref="a935bf504beb13c384b6bf2b57337b60c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_rounding.html">Rounding</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>default constructor </p>
<p>Instances built through this constructor don't perform any rounding. </p>
</div>
</div>
</div><!-- contents -->
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>
</div>
</body>
</html>
|
