File: class_quant_lib_1_1_vasicek.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 (152 lines) | stat: -rw-r--r-- 12,024 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
<!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: 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.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 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<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/models/shortrate/onefactormodels/vasicek.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Vasicek:</div>
<div class="dynsection">
<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 shape="rect" href="class_quant_lib_1_1_hull_white.html" title="Single&#45;factor Hull&#45;White (extended Vasicek) model class." alt="" coords="48,161,128,188"><area shape="rect" href="class_quant_lib_1_1_one_factor_affine_model.html" title="Single&#45;factor affine base class." alt="" coords="5,7,171,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<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" title="Vasicek model class">Vasicek</a> model defined by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dr_t = a(b - r_t)dt + \sigma dW_t , \]" src="form_234.png">
<p>
 where <img class="formulaInl" alt="$ a $" src="form_51.png">, <img class="formulaInl" alt="$ b $" src="form_52.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. <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, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> a=0.1, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> b=0.05, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> sigma=0.01, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> 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 <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>discountBondOption</b> (Option::Type type, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> bondMaturity) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b819304423e7791547c3089322a190be"></a><!-- doxytag: member="QuantLib::Vasicek::dynamics" ref="b819304423e7791547c3089322a190be" args="() const " -->
virtual boost::shared_ptr<br>
&lt; <a class="el" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html">ShortRateDynamics</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_vasicek.html#b819304423e7791547c3089322a190be">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="cc2599494b8b8a5d2dc1413f4c438aa2"></a><!-- doxytag: member="QuantLib::Vasicek::A" ref="cc2599494b8b8a5d2dc1413f4c438aa2" args="(Time t, Time T) const " -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>A</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> T) const </td></tr>

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

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb6c2cfe0928889369fc49347418ce31"></a><!-- doxytag: member="QuantLib::Vasicek::a" ref="eb6c2cfe0928889369fc49347418ce31" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&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="d1cf85afbb81add225d9d591923cae35"></a><!-- doxytag: member="QuantLib::Vasicek::b" ref="d1cf85afbb81add225d9d591923cae35" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&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="24cb1182953e872918829ca60b348e54"></a><!-- doxytag: member="QuantLib::Vasicek::lambda" ref="24cb1182953e872918829ca60b348e54" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&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="78bca11664a7d403bde6a9842f72ae61"></a><!-- doxytag: member="QuantLib::Vasicek::sigma" ref="78bca11664a7d403bde6a9842f72ae61" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&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="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&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">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>

</div>

</body>
</html>