File: class_quant_lib_1_1_vasicek.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (177 lines) | stat: -rw-r--r-- 11,519 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
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
<!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: Vasicek 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="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 -->
<div class="nav">
<b>QuantLib</b>::<a class="el" href="class_quant_lib_1_1_vasicek.html">Vasicek</a></div>
<h1>Vasicek Class Reference<br>
<small>
[<a class="el" href="group__shortrate.html">Short-rate modelling framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::Vasicek" --><!-- doxytag: inherits="QuantLib::OneFactorAffineModel" --><code>#include &lt;ql/ShortRateModels/OneFactorModels/vasicek.hpp&gt;</code>
<p>
Inheritance diagram for Vasicek:<p><center><img src="class_quant_lib_1_1_vasicek__inherit__graph.png" border="0" usemap="#_vasicek__inherit__map" alt="Inheritance graph"></center>
<map name="_vasicek__inherit__map">
<area href="class_quant_lib_1_1_hull_white.html" shape="rect" coords="86,455,174,479" alt="">
<area href="class_quant_lib_1_1_one_factor_affine_model.html" shape="rect" coords="44,305,215,329" alt="">
<area href="class_quant_lib_1_1_one_factor_model.html" shape="rect" coords="14,231,144,255" alt="">
<area href="class_quant_lib_1_1_short_rate_model.html" shape="rect" coords="6,156,134,180" alt="">
<area href="class_quant_lib_1_1_calibrated_model.html" shape="rect" coords="16,81,147,105" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="40,7,123,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="150,7,248,31" alt="">
<area href="class_quant_lib_1_1_affine_model.html" shape="rect" coords="158,156,262,180" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_vasicek-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Vasicek model class 
<p>
This class implements the <a class="el" href="class_quant_lib_1_1_vasicek.html">Vasicek</a> model defined by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dr_t = a(b - r_t)dt + \sigma dW_t , \]" src="form_217.png">
<p>
 where <img class="formulaInl" alt="$ a $" src="form_143.png">, <img class="formulaInl" alt="$ b $" src="form_144.png"> and <img class="formulaInl" alt="$ \sigma $" src="form_4.png"> are constants; a risk premium <img class="formulaInl" alt="$ \lambda $" src="form_29.png"> can also be specified. 
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3ace61536533987a5945b8f640b56ba"></a><!-- doxytag: member="QuantLib::Vasicek::Vasicek" ref="d3ace61536533987a5945b8f640b56ba" args="(Rate r0=0.05, Real a=0.1, Real b=0.05, Real sigma=0.01, Real lambda=0.0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Vasicek</b> (<a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> r0=0.05, Real a=0.1, Real b=0.05, Real sigma=0.01, Real lambda=0.0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c92e4a748c8ff38b33f1460ee56dceb"></a><!-- doxytag: member="QuantLib::Vasicek::discountBondOption" ref="7c92e4a748c8ff38b33f1460ee56dceb" args="(Option::Type type, Real strike, Time maturity, Time bondMaturity) const " -->
virtual Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>discountBondOption</b> (Option::Type type, Real strike, Time maturity, Time bondMaturity) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc90527e32f5e84d191b5984cba8df45"></a><!-- doxytag: member="QuantLib::Vasicek::dynamics" ref="fc90527e32f5e84d191b5984cba8df45" args="() const" -->
virtual boost::shared_ptr&lt;<br>
 ShortRateDynamics &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_vasicek.html#fc90527e32f5e84d191b5984cba8df45">dynamics</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the short-rate dynamics <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf84988e03484bf38109ad3abd565a4c"></a><!-- doxytag: member="QuantLib::Vasicek::A" ref="bf84988e03484bf38109ad3abd565a4c" args="(Time t, Time T) const" -->
virtual Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>A</b> (Time t, Time T) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c418cd274327445c1f93af4c8dc1b1e0"></a><!-- doxytag: member="QuantLib::Vasicek::B" ref="c418cd274327445c1f93af4c8dc1b1e0" args="(Time t, Time T) const" -->
virtual Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>B</b> (Time t, Time T) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="962375e1380660f0a2fe72e737e3950b"></a><!-- doxytag: member="QuantLib::Vasicek::a" ref="962375e1380660f0a2fe72e737e3950b" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>a</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bb198a929fb62eabaf6b36385eb2416"></a><!-- doxytag: member="QuantLib::Vasicek::b" ref="3bb198a929fb62eabaf6b36385eb2416" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>b</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="48c08d33f44bbcf1116a2e8750feddf1"></a><!-- doxytag: member="QuantLib::Vasicek::lambda" ref="48c08d33f44bbcf1116a2e8750feddf1" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>lambda</b> () const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bf7456c7feee4fc5c40c1ea775619de"></a><!-- doxytag: member="QuantLib::Vasicek::sigma" ref="3bf7456c7feee4fc5c40c1ea775619de" args="() const" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>sigma</b> () const</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21cb0313d759e9d26706f81f8a17d98c"></a><!-- doxytag: member="QuantLib::Vasicek::r0_" ref="21cb0313d759e9d26706f81f8a17d98c" args="" -->
Real&nbsp;</td><td class="memItemRight" valign="bottom"><b>r0_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4439c51d60a45db28cbc47843a73171"></a><!-- doxytag: member="QuantLib::Vasicek::a_" ref="d4439c51d60a45db28cbc47843a73171" args="" -->
<a class="el" href="class_quant_lib_1_1_parameter.html">Parameter</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>a_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11a47769611407b76d3b56ec19497841"></a><!-- doxytag: member="QuantLib::Vasicek::b_" ref="11a47769611407b76d3b56ec19497841" args="" -->
<a class="el" href="class_quant_lib_1_1_parameter.html">Parameter</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>b_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="070a7d50740ec1a9a7cab8de7a5bed62"></a><!-- doxytag: member="QuantLib::Vasicek::sigma_" ref="070a7d50740ec1a9a7cab8de7a5bed62" args="" -->
<a class="el" href="class_quant_lib_1_1_parameter.html">Parameter</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>sigma_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="145abe699377e7ed7e4be80259b3cc49"></a><!-- doxytag: member="QuantLib::Vasicek::lambda_" ref="145abe699377e7ed7e4be80259b3cc49" args="" -->
<a class="el" href="class_quant_lib_1_1_parameter.html">Parameter</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>lambda_</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_vasicek_1_1_dynamics.html">Dynamics</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Short-rate dynamics in the Vasicek model.  <a href="class_quant_lib_1_1_vasicek_1_1_dynamics.html#_details">More...</a><br></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>