File: class_quant_lib_1_1_hull_white_1_1_dynamics.html

package info (click to toggle)
quantlib-refman-html 1.20-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 103,140 kB
  • sloc: javascript: 13,408; makefile: 35
file content (140 lines) | stat: -rw-r--r-- 10,497 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: HullWhite::Dynamics Class Reference</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://quantlib.org">
       <img alt="QuantLib" src="QL-title.jpg"></a>
   <div id="projectbrief">A free/open-source library for quantitative finance</div>
   <div id="projectnumber">Reference manual - version 1.20</div>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_hull_white.html">HullWhite</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_hull_white_1_1_dynamics.html">Dynamics</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_quant_lib_1_1_hull_white_1_1_dynamics-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">HullWhite::Dynamics Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Short-rate dynamics in the Hull-White model.  
 <a href="class_quant_lib_1_1_hull_white_1_1_dynamics.html#details">More...</a></p>

<p><code>#include &lt;ql/models/shortrate/onefactormodels/hullwhite.hpp&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for HullWhite::Dynamics:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_quant_lib_1_1_hull_white_1_1_dynamics__inherit__graph.png" border="0" usemap="#a_hull_white_1_1_dynamics_inherit__map" alt="Inheritance graph"/></div>
<map name="_hull_white_1_1_dynamics_inherit__map" id="a_hull_white_1_1_dynamics_inherit__map">
<area shape="rect" title="Short&#45;rate dynamics in the Hull&#45;White model." alt="" coords="5,80,152,107"/>
<area shape="rect" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html" title="Base class describing the short&#45;rate dynamics." alt="" coords="9,5,149,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a007a2e1b524bd7656fd5528934b497f7"><td class="memItemLeft" align="right" valign="top"><a id="a007a2e1b524bd7656fd5528934b497f7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Dynamics</b> (const <a class="el" href="class_quant_lib_1_1_parameter.html">Parameter</a> &amp;fitting, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> a, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> sigma)</td></tr>
<tr class="separator:a007a2e1b524bd7656fd5528934b497f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16f39c63a6c9a8918feafa713c610c86"><td class="memItemLeft" align="right" valign="top"><a id="a16f39c63a6c9a8918feafa713c610c86"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_hull_white_1_1_dynamics.html#a16f39c63a6c9a8918feafa713c610c86">variable</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> r) const</td></tr>
<tr class="memdesc:a16f39c63a6c9a8918feafa713c610c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute state variable from short rate. <br /></td></tr>
<tr class="separator:a16f39c63a6c9a8918feafa713c610c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1863f46430e668bfc47943686c8e78e8"><td class="memItemLeft" align="right" valign="top"><a id="a1863f46430e668bfc47943686c8e78e8"></a>
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_hull_white_1_1_dynamics.html#a1863f46430e668bfc47943686c8e78e8">shortRate</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x) const</td></tr>
<tr class="memdesc:a1863f46430e668bfc47943686c8e78e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute short rate from state variable. <br /></td></tr>
<tr class="separator:a1863f46430e668bfc47943686c8e78e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html">OneFactorModel::ShortRateDynamics</a></td></tr>
<tr class="memitem:abf095c87c35d04b8dd0bd652417338e9 inherit pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics"><td class="memItemLeft" align="right" valign="top"><a id="abf095c87c35d04b8dd0bd652417338e9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ShortRateDynamics</b> (const ext::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html">StochasticProcess1D</a> &gt; &amp;<a class="el" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html#a5a9404ed5bf426e14c92f48328c85d1b">process</a>)</td></tr>
<tr class="separator:abf095c87c35d04b8dd0bd652417338e9 inherit pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a9404ed5bf426e14c92f48328c85d1b inherit pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics"><td class="memItemLeft" align="right" valign="top"><a id="a5a9404ed5bf426e14c92f48328c85d1b"></a>
const ext::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html">StochasticProcess1D</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html#a5a9404ed5bf426e14c92f48328c85d1b">process</a> ()</td></tr>
<tr class="memdesc:a5a9404ed5bf426e14c92f48328c85d1b inherit pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the risk-neutral dynamics of the state variable. <br /></td></tr>
<tr class="separator:a5a9404ed5bf426e14c92f48328c85d1b inherit pub_methods_class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Short-rate dynamics in the Hull-White model. </p>
<p>The short-rate is here </p><p class="formulaDsp">
\[ r_t = \varphi(t) + x_t \]
</p>
<p> where \( \varphi(t) \) is the deterministic time-dependent parameter used for term-structure fitting and \( x_t \) is the state variable following an Ornstein-Uhlenbeck process. </p>
</div></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>