File: class_quant_lib_1_1_one_factor_affine_model.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (131 lines) | stat: -rw-r--r-- 9,272 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
<!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>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="185" height="50" 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 1.2</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="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="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="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_one_factor_affine_model.html">OneFactorAffineModel</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">OneFactorAffineModel Class Reference<div class="ingroups"><a class="el" href="group__shortrate.html">Short-rate modelling framework</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::OneFactorAffineModel" --><!-- doxytag: inherits="QuantLib::OneFactorModel,QuantLib::AffineModel" -->
<p>Single-factor affine base class.  
 <a href="class_quant_lib_1_1_one_factor_affine_model.html#details">More...</a></p>

<p><code>#include &lt;ql/models/shortrate/onefactormodel.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OneFactorAffineModel:</div>
<div class="dyncontent">
<div class="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"/></div>
<map name="_one_factor_affine_model_inherit__map" id="_one_factor_affine_model_inherit__map">
<area shape="rect" id="node7" href="class_quant_lib_1_1_cox_ingersoll_ross.html" title="Cox&#45;Ingersoll&#45;Ross model class." alt="" coords="7,166,129,197"/><area shape="rect" id="node9" href="class_quant_lib_1_1_vasicek.html" title="Vasicek model class" alt="" coords="153,166,220,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_one_factor_model.html" title="Single&#45;factor short&#45;rate model abstract class." alt="" coords="5,6,123,37"/><area shape="rect" id="node4" href="class_quant_lib_1_1_affine_model.html" title="Affine model class." alt="" coords="147,6,235,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_one_factor_affine_model-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ba76488a8dafa032560538843a5737f"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::OneFactorAffineModel" ref="a7ba76488a8dafa032560538843a5737f" args="(Size nArguments)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>OneFactorAffineModel</b> (<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> nArguments)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e6da6d0ea51cae74b4ec8903bf09f18"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discountBond" ref="a6e6da6d0ea51cae74b4ec8903bf09f18" args="(Time now, Time maturity, Array factors) const " -->
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>discountBond</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> now, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity, <a class="el" href="class_quant_lib_1_1_array.html">Array</a> factors) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa260e038c388bc1476369ebfcd750ca2"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discountBond" ref="aa260e038c388bc1476369ebfcd750ca2" args="(Time now, Time maturity, Rate rate) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>discountBond</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> now, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> maturity, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> rate) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae85d814b067b54d8e1ea803a90a6db32"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::discount" ref="ae85d814b067b54d8e1ea803a90a6db32" args="(Time t) const " -->
<a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_one_factor_affine_model.html#ae85d814b067b54d8e1ea803a90a6db32">discount</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Implied discount curve. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ed7d49affc03f9aa87689d34f645b40"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::A" ref="a8ed7d49affc03f9aa87689d34f645b40" args="(Time t, Time T) const =0" -->
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>A</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> T) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9e6606d18d6623637404a38005d1553"></a><!-- doxytag: member="QuantLib::OneFactorAffineModel::B" ref="ab9e6606d18d6623637404a38005d1553" args="(Time t, Time T) const =0" -->
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>B</b> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> T) const =0</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Single-factor affine base class. </p>
<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_289.png"/> and <img class="formulaInl" alt="$ B(t,T) $" src="form_290.png"/> such that </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ P(t, T, r_t) = A(t,T)e^{ -B(t,T) r_t}. \]" src="form_291.png"/>
</p>
 </div></div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>