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
153
154
155
|
<!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: G2 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_g2.html">G2</a></div>
<h1>G2 Class Reference<br>
<small>
[<a class="el" href="group__shortrate.html">Short-rate modelling framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::G2" --><!-- doxytag: inherits="QuantLib::TwoFactorModel,QuantLib::AffineModel,QuantLib::TermStructureConsistentModel" --><code>#include <ql/models/shortrate/twofactormodels/g2.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for G2:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_g2__inherit__graph.png" border="0" usemap="#_g2__inherit__map" alt="Inheritance graph"></center>
<map name="_g2__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_two_factor_model.html" title="Abstract base-class for two-factor models." alt="" coords="5,7,128,33"><area shape="rect" href="class_quant_lib_1_1_affine_model.html" title="Affine model class." alt="" coords="152,7,251,33"><area shape="rect" href="class_quant_lib_1_1_term_structure_consistent_model.html" title="Term-structure consistent model class." alt="" coords="275,7,496,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_g2-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Two-additive-factor gaussian model class.
<p>
This class implements a two-additive-factor model defined by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dr_t = \varphi(t) + x_t + y_t \]" src="form_242.png">
<p>
where <img class="formulaInl" alt="$ x_t $" src="form_222.png"> and <img class="formulaInl" alt="$ y_t $" src="form_224.png"> are defined by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dx_t = -a x_t dt + \sigma dW^1_t, x_0 = 0 \]" src="form_243.png">
<p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ dy_t = -b y_t dt + \sigma dW^2_t, y_0 = 0 \]" src="form_244.png">
<p>
and <img class="formulaInl" alt="$ dW^1_t dW^2_t = \rho dt $" src="form_245.png">.<p>
<dl compact><dt><b><a class="el" href="bug.html#_bug000007">Bug:</a></b></dt><dd>This class was not tested enough to guarantee its functionality.</dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="_bermudan_swaption_8cpp-example.html#_a29">BermudanSwaption.cpp</a>.</dl><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="1b9ab301f7d3d660be61f73e3a384704"></a><!-- doxytag: member="QuantLib::G2::G2" ref="1b9ab301f7d3d660be61f73e3a384704" args="(const Handle< YieldTermStructure > &termStructure, Real a=0.1, Real sigma=0.01, Real b=0.1, Real eta=0.01, Real rho=-0.75)" -->
</td><td class="memItemRight" valign="bottom"><b>G2</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > &termStructure, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> a=0.1, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> sigma=0.01, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> b=0.1, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> eta=0.01, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> rho=-0.75)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89786edacdadb5904c317fd4ed5cb3bd"></a><!-- doxytag: member="QuantLib::G2::dynamics" ref="89786edacdadb5904c317fd4ed5cb3bd" args="() const " -->
boost::shared_ptr<br>
< <a class="el" href="class_quant_lib_1_1_two_factor_model_1_1_short_rate_dynamics.html">ShortRateDynamics</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2.html#89786edacdadb5904c317fd4ed5cb3bd">dynamics</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the short-rate dynamics. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e6da6d0ea51cae74b4ec8903bf09f18"></a><!-- doxytag: member="QuantLib::G2::discountBond" ref="6e6da6d0ea51cae74b4ec8903bf09f18" args="(Time now, Time maturity, Array factors) const " -->
virtual <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </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="892bc207d2b8c0119a2ac775a2909e81"></a><!-- doxytag: member="QuantLib::G2::discountBond" ref="892bc207d2b8c0119a2ac775a2909e81" args="(Time, Time, Rate, Rate) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>discountBond</b> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a>) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b47448ed1ba48ac5138854aed3f1d49"></a><!-- doxytag: member="QuantLib::G2::discountBondOption" ref="0b47448ed1ba48ac5138854aed3f1d49" args="(Option::Type type, Real strike, Time maturity, Time bondMaturity) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </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="753509dd7d4a657ab5fe37de3a12d063"></a><!-- doxytag: member="QuantLib::G2::swaption" ref="753509dd7d4a657ab5fe37de3a12d063" args="(const Swaption::arguments &arguments, Rate fixedRate, Real range, Size intervals) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>swaption</b> (const <a class="el" href="class_quant_lib_1_1_swaption_1_1arguments.html">Swaption::arguments</a> &arguments, <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> fixedRate, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> range, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> intervals) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e85d814b067b54d8e1ea803a90a6db32"></a><!-- doxytag: member="QuantLib::G2::discount" ref="e85d814b067b54d8e1ea803a90a6db32" args="(Time t) const " -->
<a class="el" href="group__types.html#g642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2.html#e85d814b067b54d8e1ea803a90a6db32">discount</a> (<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td class="mdescLeft"> </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="4d8a7e8e132cf1dd8d1d9eac02f2bfae"></a><!-- doxytag: member="QuantLib::G2::generateArguments" ref="4d8a7e8e132cf1dd8d1d9eac02f2bfae" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>generateArguments</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01dd11c13189fcd655784ccec798c410"></a><!-- doxytag: member="QuantLib::G2::A" ref="01dd11c13189fcd655784ccec798c410" args="(Time t, Time T) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </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="ee8a4bf8e1d1b7f34a5b37a9425c7817"></a><!-- doxytag: member="QuantLib::G2::B" ref="ee8a4bf8e1d1b7f34a5b37a9425c7817" args="(Real x, Time t) const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>B</b> (<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> x, <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1003a7fa35165c1ed94e5eeb68807e4f"></a><!-- doxytag: member="QuantLib::G2::SwaptionPricingFunction" ref="1003a7fa35165c1ed94e5eeb68807e4f" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>SwaptionPricingFunction</b></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_g2_1_1_fitting_parameter.html">FittingParameter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analytical term-structure fitting parameter <img class="formulaInl" alt="$ \varphi(t) $" src="form_221.png">. <a href="class_quant_lib_1_1_g2_1_1_fitting_parameter.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>
|
