File: class_quant_lib_1_1_one_factor_affine_model.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 (149 lines) | stat: -rw-r--r-- 8,857 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
<!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: OneFactorAffineModel 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_one_factor_affine_model.html">OneFactorAffineModel</a></div>
<h1>OneFactorAffineModel Class Reference<br>
<small>
[<a class="el" href="group__shortrate.html">Short-rate modelling framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::OneFactorAffineModel" --><!-- doxytag: inherits="QuantLib::OneFactorModel,QuantLib::AffineModel" --><code>#include &lt;ql/ShortRateModels/onefactormodel.hpp&gt;</code>
<p>
Inheritance diagram for OneFactorAffineModel:<p><center><img src="class_quant_lib_1_1_one_factor_affine_model__inherit__graph.png" border="0" usemap="#_one_factor_affine_model__inherit__map" alt="Inheritance graph"></center>
<map name="_one_factor_affine_model__inherit__map">
<area href="class_quant_lib_1_1_cox_ingersoll_ross.html" shape="rect" coords="47,380,183,404" alt="">
<area href="class_quant_lib_1_1_vasicek.html" shape="rect" coords="226,380,300,404" alt="">
<area href="class_quant_lib_1_1_one_factor_model.html" shape="rect" coords="63,231,194,255" alt="">
<area href="class_quant_lib_1_1_short_rate_model.html" shape="rect" coords="55,156,183,180" alt="">
<area href="class_quant_lib_1_1_calibrated_model.html" shape="rect" coords="66,81,196,105" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="90,7,172,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="199,7,298,31" alt="">
<area href="class_quant_lib_1_1_affine_model.html" shape="rect" coords="207,156,311,180" alt="">
<area href="class_quant_lib_1_1_extended_cox_ingersoll_ross.html" shape="rect" coords="6,455,206,479" alt="">
<area href="class_quant_lib_1_1_hull_white.html" shape="rect" coords="230,455,318,479" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_one_factor_affine_model-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Single-factor affine base class. 
<p>
Single-factor models with an analytical formula for discount bonds should inherit from this class. They must then implement the functions <img class="formulaInl" alt="$ A(t,T) $" src="form_197.png"> and <img class="formulaInl" alt="$ B(t,T) $" src="form_198.png"> such that <p class="formulaDsp">
<img class="formulaDsp" alt="\[ P(t, T, r_t) = A(t,T)e^{ -B(t,T) r_t}. \]" src="form_199.png">
<p>
 
<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="7ba76488a8dafa032560538843a5737f"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::OneFactorAffineModel" ref="7ba76488a8dafa032560538843a5737f" args="(Size nArguments)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>OneFactorAffineModel</b> (Size nArguments)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28b8fe8e1849a874ebb63691d20b72df"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discountBond" ref="28b8fe8e1849a874ebb63691d20b72df" args="(Time now, Time maturity, Array factors) const" -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>discountBond</b> (Time now, Time maturity, <a class="el" href="class_quant_lib_1_1_array.html">Array</a> factors) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a197593574e9905998cee94adc4aa34f"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discountBond" ref="a197593574e9905998cee94adc4aa34f" args="(Time now, Time maturity, Rate rate) const" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>discountBond</b> (Time now, Time maturity, Rate rate) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69a7c0281cc05c0c70142afd62e7b0f1"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discount" ref="69a7c0281cc05c0c70142afd62e7b0f1" args="(Time t) const" -->
<a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_one_factor_affine_model.html#69a7c0281cc05c0c70142afd62e7b0f1">discount</a> (Time t) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implied discount curve. <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="5f8aea05dbd4fb46b3ef0dc16fcea9e6"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::A" ref="5f8aea05dbd4fb46b3ef0dc16fcea9e6" args="(Time t, Time T) const=0" -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>A</b> (Time t, Time T) const=0</td></tr>

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