File: class_quant_lib_1_1_one_factor_affine_model.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 (122 lines) | stat: -rw-r--r-- 8,659 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
<!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: 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.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_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/models/shortrate/onefactormodel.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for OneFactorAffineModel:</div>
<div class="dynsection">
<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 shape="rect" href="class_quant_lib_1_1_cox_ingersoll_ross.html" title="Cox&#45;Ingersoll&#45;Ross model class." alt="" coords="9,161,140,188"><area shape="rect" href="class_quant_lib_1_1_vasicek.html" title="Vasicek model class" alt="" coords="164,161,231,188"><area shape="rect" href="class_quant_lib_1_1_one_factor_model.html" title="Single&#45;factor short&#45;rate model abstract class." alt="" coords="5,7,131,33"><area shape="rect" href="class_quant_lib_1_1_affine_model.html" title="Affine model class." alt="" coords="155,7,253,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<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_215.png"> and <img class="formulaInl" alt="$ B(t,T) $" src="form_216.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_217.png">
<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> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> nArguments)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e6da6d0ea51cae74b4ec8903bf09f18"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discountBond" ref="6e6da6d0ea51cae74b4ec8903bf09f18" 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> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> now, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> 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="a260e038c388bc1476369ebfcd750ca2"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discountBond" ref="a260e038c388bc1476369ebfcd750ca2" 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> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> now, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> rate) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e85d814b067b54d8e1ea803a90a6db32"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discount" ref="e85d814b067b54d8e1ea803a90a6db32" 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#e85d814b067b54d8e1ea803a90a6db32">discount</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> 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="8ed7d49affc03f9aa87689d34f645b40"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::A" ref="8ed7d49affc03f9aa87689d34f645b40" 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> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> T) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9e6606d18d6623637404a38005d1553"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::B" ref="b9e6606d18d6623637404a38005d1553" 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> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> T) const =0</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>