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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
|
<!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: Numeric types</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>Numeric types</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
A number of numeric types are defined in order to add clarity to function and method declarations.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QL_INTEGER </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#gb9c87440c314438e51a899a03d2442d0">Integer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">integer number <a href="#gb9c87440c314438e51a899a03d2442d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QL_BIG_INTEGER </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#g4f0ecbbf99e41b6d69cd54871d5d2b9e">BigInteger</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">large integer number <a href="#g4f0ecbbf99e41b6d69cd54871d5d2b9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned QL_INTEGER </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">positive integer <a href="#g7e529c39c477ba1f5a22264d93e8457a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QL_REAL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">real number <a href="#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Real </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#gee215f8d421f6afcede0391fcffb5fe7">Decimal</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">decimal number <a href="#gee215f8d421f6afcede0391fcffb5fe7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">size of a container <a href="#gf38bdb4c54463b1f456655efa95b5c77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Real </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">continuous quantity with 1-year units <a href="#g14fb8fca43a68f4168654e1f9f7e22f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Real </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">discount factor between dates <a href="#g642a971a0bcbbd2fb26c35e1a06e5761"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Real </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">interest rates <a href="#gede435af51236692b1107d7639581d39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Real </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#ge7427f4743503002b0c6eeeefae91a3d">Spread</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">spreads on interest rates <a href="#ge7427f4743503002b0c6eeeefae91a3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Real </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types.html#gaa95ab7fe66935e3f7535413fad2a7d3">Volatility</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">volatility <a href="#gaa95ab7fe66935e3f7535413fad2a7d3"></a><br></td></tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="gb9c87440c314438e51a899a03d2442d0"></a><!-- doxytag: member="QuantLib::Integer" ref="gb9c87440c314438e51a899a03d2442d0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef QL_INTEGER Integer </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
integer number
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_bermudan_swaption_8cpp-example.html#a0">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#a0">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#a0">DiscreteHedging.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#a0">EquityOption.cpp</a>, <a class="el" href="_fitted_bond_curve_8cpp-example.html#a0">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#a0">FRA.cpp</a>, <a class="el" href="_replication_8cpp-example.html#a0">Replication.cpp</a>, <a class="el" href="_repo_8cpp-example.html#a0">Repo.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#a0">swapvaluation.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g4f0ecbbf99e41b6d69cd54871d5d2b9e"></a><!-- doxytag: member="QuantLib::BigInteger" ref="g4f0ecbbf99e41b6d69cd54871d5d2b9e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef QL_BIG_INTEGER BigInteger </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
large integer number
<p>
</div>
</div><p>
<a class="anchor" name="g7e529c39c477ba1f5a22264d93e8457a"></a><!-- doxytag: member="QuantLib::Natural" ref="g7e529c39c477ba1f5a22264d93e8457a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned QL_INTEGER Natural </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
positive integer
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_fitted_bond_curve_8cpp-example.html#a15">FittedBondCurve.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g4bdf4bfe76b9ffa6fa64c47d8bfa0c78"></a><!-- doxytag: member="QuantLib::Real" ref="g4bdf4bfe76b9ffa6fa64c47d8bfa0c78" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef QL_REAL Real </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
real number
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_bermudan_swaption_8cpp-example.html#a5">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#a1">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#a2">DiscreteHedging.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#a4">EquityOption.cpp</a>, <a class="el" href="_fitted_bond_curve_8cpp-example.html#a2">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#a15">FRA.cpp</a>, <a class="el" href="_replication_8cpp-example.html#a2">Replication.cpp</a>, <a class="el" href="_repo_8cpp-example.html#a7">Repo.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#a8">swapvaluation.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="gee215f8d421f6afcede0391fcffb5fe7"></a><!-- doxytag: member="QuantLib::Decimal" ref="gee215f8d421f6afcede0391fcffb5fe7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Real Decimal </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
decimal number
<p>
</div>
</div><p>
<a class="anchor" name="gf38bdb4c54463b1f456655efa95b5c77"></a><!-- doxytag: member="QuantLib::Size" ref="gf38bdb4c54463b1f456655efa95b5c77" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::size_t Size </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
size of a container
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_bermudan_swaption_8cpp-example.html#a1">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#a17">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#a8">DiscreteHedging.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#a12">EquityOption.cpp</a>, <a class="el" href="_fitted_bond_curve_8cpp-example.html#a1">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#a16">FRA.cpp</a>, <a class="el" href="_replication_8cpp-example.html#a5">Replication.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#a30">swapvaluation.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g14fb8fca43a68f4168654e1f9f7e22f7"></a><!-- doxytag: member="QuantLib::Time" ref="g14fb8fca43a68f4168654e1f9f7e22f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Real Time </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
continuous quantity with 1-year units
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_convertible_bonds_8cpp-example.html#a23">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#a1">DiscreteHedging.cpp</a>, and <a class="el" href="_fitted_bond_curve_8cpp-example.html#a25">FittedBondCurve.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g642a971a0bcbbd2fb26c35e1a06e5761"></a><!-- doxytag: member="QuantLib::DiscountFactor" ref="g642a971a0bcbbd2fb26c35e1a06e5761" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Real DiscountFactor </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
discount factor between dates
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_discrete_hedging_8cpp-example.html#a5">DiscreteHedging.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="gede435af51236692b1107d7639581d39"></a><!-- doxytag: member="QuantLib::Rate" ref="gede435af51236692b1107d7639581d39" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Real Rate </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
interest rates
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_bermudan_swaption_8cpp-example.html#a20">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#a3">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#a4">DiscreteHedging.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#a6">EquityOption.cpp</a>, <a class="el" href="_fitted_bond_curve_8cpp-example.html#a28">FittedBondCurve.cpp</a>, <a class="el" href="_f_r_a_8cpp-example.html#a7">FRA.cpp</a>, <a class="el" href="_repo_8cpp-example.html#a2">Repo.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#a7">swapvaluation.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="ge7427f4743503002b0c6eeeefae91a3d"></a><!-- doxytag: member="QuantLib::Spread" ref="ge7427f4743503002b0c6eeeefae91a3d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Real Spread </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
spreads on interest rates
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_convertible_bonds_8cpp-example.html#a2">ConvertibleBonds.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#a5">EquityOption.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#a26">swapvaluation.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="gaa95ab7fe66935e3f7535413fad2a7d3"></a><!-- doxytag: member="QuantLib::Volatility" ref="gaa95ab7fe66935e3f7535413fad2a7d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Real Volatility </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
volatility
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_bermudan_swaption_8cpp-example.html#a2">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#a4">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#a3">DiscreteHedging.cpp</a>, and <a class="el" href="_equity_option_8cpp-example.html#a7">EquityOption.cpp</a>.</dl>
</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>
|