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 156 157 158
|
<!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: ExtendedCoxIngersollRoss 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_extended_cox_ingersoll_ross.html">ExtendedCoxIngersollRoss</a></div>
<h1>ExtendedCoxIngersollRoss Class Reference<br>
<small>
[<a class="el" href="group__shortrate.html">Short-rate modelling framework</a>]</small>
</h1><!-- doxytag: class="QuantLib::ExtendedCoxIngersollRoss" --><!-- doxytag: inherits="QuantLib::CoxIngersollRoss,QuantLib::TermStructureConsistentModel" --><code>#include <ql/ShortRateModels/OneFactorModels/extendedcoxingersollross.hpp></code>
<p>
Inheritance diagram for ExtendedCoxIngersollRoss:<p><center><img src="class_quant_lib_1_1_extended_cox_ingersoll_ross__inherit__graph.png" border="0" usemap="#_extended_cox_ingersoll_ross__inherit__map" alt="Inheritance graph"></center>
<map name="_extended_cox_ingersoll_ross__inherit__map">
<area href="class_quant_lib_1_1_cox_ingersoll_ross.html" shape="rect" coords="113,380,249,404" alt="">
<area href="class_quant_lib_1_1_one_factor_affine_model.html" shape="rect" coords="88,305,259,329" alt="">
<area href="class_quant_lib_1_1_one_factor_model.html" shape="rect" coords="5,231,136,255" alt="">
<area href="class_quant_lib_1_1_short_rate_model.html" shape="rect" coords="7,156,135,180" alt="">
<area href="class_quant_lib_1_1_calibrated_model.html" shape="rect" coords="19,81,149,105" alt="">
<area href="class_quant_lib_1_1_observer.html" shape="rect" coords="43,7,125,31" alt="">
<area href="class_quant_lib_1_1_observable.html" shape="rect" coords="161,7,260,31" alt="">
<area href="class_quant_lib_1_1_affine_model.html" shape="rect" coords="159,156,263,180" alt="">
<area href="class_quant_lib_1_1_term_structure_consistent_model.html" shape="rect" coords="211,231,440,255" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_extended_cox_ingersoll_ross-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Extended Cox-Ingersoll-Ross model class.
<p>
This class implements the extended Cox-Ingersoll-Ross model defined by <p class="formulaDsp">
<img class="formulaDsp" alt="\[ dr_t = (\theta(t) - \alpha r_t)dt + \sqrt{r_t}\sigma dW_t . \]" src="form_209.png">
<p>
<p>
<dl compact><dt><b><a class="el" href="bug.html#_bug000008">Bug:</a></b></dt><dd>this class was not tested enough to guarantee its functionality.</dd></dl>
<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="88667693f84f2d60e897a566c9fc1e7f"></a><!-- doxytag: member="QuantLib::ExtendedCoxIngersollRoss::ExtendedCoxIngersollRoss" ref="88667693f84f2d60e897a566c9fc1e7f" args="(const Handle< YieldTermStructure > &termStructure, Real theta=0.1, Real k=0.1, Real sigma=0.1, Real x0=0.05)" -->
</td><td class="memItemRight" valign="bottom"><b>ExtendedCoxIngersollRoss</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, Real theta=0.1, Real k=0.1, Real sigma=0.1, Real x0=0.05)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="140a7c576c87942d7f5a10db36affe8c"></a><!-- doxytag: member="QuantLib::ExtendedCoxIngersollRoss::tree" ref="140a7c576c87942d7f5a10db36affe8c" args="(const TimeGrid &grid) const " -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_numerical_method.html">NumericalMethod</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_extended_cox_ingersoll_ross.html#140a7c576c87942d7f5a10db36affe8c">tree</a> (const <a class="el" href="class_quant_lib_1_1_time_grid.html">TimeGrid</a> &grid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return by default a trinomial recombining tree. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc90527e32f5e84d191b5984cba8df45"></a><!-- doxytag: member="QuantLib::ExtendedCoxIngersollRoss::dynamics" ref="fc90527e32f5e84d191b5984cba8df45" args="() const" -->
boost::shared_ptr< ShortRateDynamics > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_extended_cox_ingersoll_ross.html#fc90527e32f5e84d191b5984cba8df45">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="0b47448ed1ba48ac5138854aed3f1d49"></a><!-- doxytag: member="QuantLib::ExtendedCoxIngersollRoss::discountBondOption" ref="0b47448ed1ba48ac5138854aed3f1d49" args="(Option::Type type, Real strike, Time maturity, Time bondMaturity) const " -->
Real </td><td class="memItemRight" valign="bottom"><b>discountBondOption</b> (Option::Type type, Real strike, Time maturity, Time bondMaturity) const </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::ExtendedCoxIngersollRoss::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="cc348b40097f738841cc2b04eccb9ee3"></a><!-- doxytag: member="QuantLib::ExtendedCoxIngersollRoss::A" ref="cc348b40097f738841cc2b04eccb9ee3" args="(Time t, Time T) const" -->
Real </td><td class="memItemRight" valign="bottom"><b>A</b> (Time t, Time T) const</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_extended_cox_ingersoll_ross_1_1_dynamics.html">Dynamics</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Short-rate dynamics in the extended Cox-Ingersoll-Ross model. <a href="class_quant_lib_1_1_extended_cox_ingersoll_ross_1_1_dynamics.html#_details">More...</a><br></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_extended_cox_ingersoll_ross_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_204.png">. <a href="class_quant_lib_1_1_extended_cox_ingersoll_ross_1_1_fitting_parameter.html#_details">More...</a><br></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>
|