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
|
<!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>OneFactorModel 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_model.html">OneFactorModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">OneFactorModel 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::OneFactorModel" --><!-- doxytag: inherits="QuantLib::ShortRateModel" -->
<p>Single-factor short-rate model abstract class.
<a href="class_quant_lib_1_1_one_factor_model.html#details">More...</a></p>
<p><code>#include <ql/models/shortrate/onefactormodel.hpp></code></p>
<div class="dynheader">
Inheritance diagram for OneFactorModel:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_one_factor_model__inherit__graph.png" border="0" usemap="#_one_factor_model_inherit__map" alt="Inheritance graph"/></div>
<map name="_one_factor_model_inherit__map" id="_one_factor_model_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_black_karasinski.html" title="Standard Black-Karasinski model class." alt="" coords="5,166,120,197"/><area shape="rect" id="node7" href="class_quant_lib_1_1_generalized_hull_white.html" title="Generalized Hull-White model class." alt="" coords="144,166,291,197"/><area shape="rect" id="node9" href="class_quant_lib_1_1_one_factor_affine_model.html" title="Single-factor affine base class." alt="" coords="315,166,464,197"/><area shape="rect" id="node2" href="class_quant_lib_1_1_short_rate_model.html" title="Abstract short-rate model class." alt="" coords="160,6,275,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_model-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html">ShortRateDynamics</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class describing the short-rate dynamics. <a href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_dynamics.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_tree.html">ShortRateTree</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Recombining trinomial tree discretizing the state variable. <a href="class_quant_lib_1_1_one_factor_model_1_1_short_rate_tree.html#details">More...</a><br/></td></tr>
<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="a9063908949ff755f1a8ac0562b05d6a0"></a><!-- doxytag: member="QuantLib::OneFactorModel::OneFactorModel" ref="a9063908949ff755f1a8ac0562b05d6a0" args="(Size nArguments)" -->
 </td><td class="memItemRight" valign="bottom"><b>OneFactorModel</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="a72b4214fbe5a64ae836f4e29f33d30cc"></a><!-- doxytag: member="QuantLib::OneFactorModel::dynamics" ref="a72b4214fbe5a64ae836f4e29f33d30cc" args="() const =0" -->
virtual boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_one_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_one_factor_model.html#a72b4214fbe5a64ae836f4e29f33d30cc">dynamics</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the short-rate dynamics <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14130554fc69efb397b13bff53cc5eeb"></a><!-- doxytag: member="QuantLib::OneFactorModel::tree" ref="a14130554fc69efb397b13bff53cc5eeb" args="(const TimeGrid &grid) const " -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_lattice.html">Lattice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_one_factor_model.html#a14130554fc69efb397b13bff53cc5eeb">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>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Single-factor short-rate model abstract class. </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>
|