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 159 160 161
|
<!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>HazardRateStructure 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_hazard_rate_structure.html">HazardRateStructure</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">HazardRateStructure Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::HazardRateStructure" --><!-- doxytag: inherits="QuantLib::DefaultProbabilityTermStructure" -->
<p>Hazard-rate term structure.
<a href="class_quant_lib_1_1_hazard_rate_structure.html#details">More...</a></p>
<p><code>#include <ql/termstructures/credit/hazardratestructure.hpp></code></p>
<div class="dynheader">
Inheritance diagram for HazardRateStructure:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_hazard_rate_structure__inherit__graph.png" border="0" usemap="#_hazard_rate_structure_inherit__map" alt="Inheritance graph"/></div>
<map name="_hazard_rate_structure_inherit__map" id="_hazard_rate_structure_inherit__map">
<area shape="rect" id="node5" href="class_quant_lib_1_1_factor_spreaded_hazard_rate_curve.html" title="Default-probability structure with a multiplicative spread on hazard rates." alt="" coords="487,5,703,35"/><area shape="rect" id="node7" href="class_quant_lib_1_1_flat_hazard_rate.html" title="Flat hazard-rate curve." alt="" coords="539,58,651,89"/><area shape="rect" id="node9" href="class_quant_lib_1_1_interpolated_hazard_rate_curve.html" title="DefaultProbabilityTermStructure based on interpolation of hazard rates." alt="" coords="455,111,735,142"/><area shape="rect" id="node11" href="class_quant_lib_1_1_spreaded_hazard_rate_curve.html" title="Default-probability structure with an additive spread on hazard rates." alt="" coords="505,165,684,195"/><area shape="rect" id="node2" href="class_quant_lib_1_1_default_probability_term_structure.html" title="Default probability term structure." alt="" coords="7,85,212,115"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_hazard_rate_structure-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 colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>See the <a class="el" href="class_quant_lib_1_1_term_structure.html" title="Basic term-structure functionality.">TermStructure</a> documentation for issues regarding constructors. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebe7f4eec2f7b0ac408f119e8f55f00f"></a><!-- doxytag: member="QuantLib::HazardRateStructure::HazardRateStructure" ref="aebe7f4eec2f7b0ac408f119e8f55f00f" args="(const DayCounter &dayCounter=DayCounter(), const std::vector< Handle< Quote > > &jumps=std::vector< Handle< Quote > >(), const std::vector< Date > &jumpDates=std::vector< Date >())" -->
 </td><td class="memItemRight" valign="bottom"><b>HazardRateStructure</b> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &<a class="el" href="class_quant_lib_1_1_term_structure.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>(), const std::vector< <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > > &jumps=std::vector< <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > >(), const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &jumpDates=std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add911afdb453b876956e1b50c38155ee"></a><!-- doxytag: member="QuantLib::HazardRateStructure::HazardRateStructure" ref="add911afdb453b876956e1b50c38155ee" args="(const Date &referenceDate, const Calendar &cal=Calendar(), const DayCounter &dayCounter=DayCounter(), const std::vector< Handle< Quote > > &jumps=std::vector< Handle< Quote > >(), const std::vector< Date > &jumpDates=std::vector< Date >())" -->
 </td><td class="memItemRight" valign="bottom"><b>HazardRateStructure</b> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &<a class="el" href="class_quant_lib_1_1_term_structure.html#aa9ae6cc6009ac64d4f265065eab08be0">referenceDate</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &cal=<a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a>(), const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &<a class="el" href="class_quant_lib_1_1_term_structure.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>(), const std::vector< <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > > &jumps=std::vector< <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > >(), const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &jumpDates=std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f10554b257e7721ec11501c3d0c2ba7"></a><!-- doxytag: member="QuantLib::HazardRateStructure::HazardRateStructure" ref="a7f10554b257e7721ec11501c3d0c2ba7" args="(Natural settlementDays, const Calendar &cal, const DayCounter &dayCounter=DayCounter(), const std::vector< Handle< Quote > > &jumps=std::vector< Handle< Quote > >(), const std::vector< Date > &jumpDates=std::vector< Date >())" -->
 </td><td class="memItemRight" valign="bottom"><b>HazardRateStructure</b> (<a class="el" href="group__types.html#ga7e529c39c477ba1f5a22264d93e8457a">Natural</a> <a class="el" href="class_quant_lib_1_1_term_structure.html#ab6506da60fec85c6f146f1b43116de70">settlementDays</a>, const <a class="el" href="class_quant_lib_1_1_calendar.html">Calendar</a> &cal, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &<a class="el" href="class_quant_lib_1_1_term_structure.html#ac147d63df367bbe5282b76b1f98cb9be">dayCounter</a>=<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>(), const std::vector< <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > > &jumps=std::vector< <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> > >(), const std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> > &jumpDates=std::vector< <a class="el" href="class_quant_lib_1_1_date.html">Date</a> >())</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Calculations</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>This method must be implemented in derived classes to perform the actual calculations. When it is called, range check has already been performed; therefore, it must assume that extrapolation is required. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0186c4f02893fb518ec1eac362e77e35"></a><!-- doxytag: member="QuantLib::HazardRateStructure::hazardRateImpl" ref="a0186c4f02893fb518ec1eac362e77e35" args="(Time) const =0" -->
virtual <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_hazard_rate_structure.html#a0186c4f02893fb518ec1eac362e77e35">hazardRateImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">hazard rate calculation <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">DefaultProbabilityTermStructure implementation</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#gad9817a6a21dfcb91429f0152c99d6313">Probability</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_hazard_rate_structure.html#a9ea9cd8b6b75f0c6e5ed1d907dfe63e1">survivalProbabilityImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacf490703e42933ebc53ef281a4a38fb"></a><!-- doxytag: member="QuantLib::HazardRateStructure::defaultDensityImpl" ref="aacf490703e42933ebc53ef281a4a38fb" args="(Time) const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_hazard_rate_structure.html#aacf490703e42933ebc53ef281a4a38fb">defaultDensityImpl</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default density calculation <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Hazard-rate term structure. </p>
<p>This abstract class acts as an adapter to <a class="el" href="class_quant_lib_1_1_default_probability_term_structure.html" title="Default probability term structure.">DefaultProbabilityTermStructure</a> allowing the programmer to implement only the <code>hazardRateImpl(Time)</code> method in derived classes.</p>
<p>Survival/default probabilities and default densities are calculated from hazard rates.</p>
<p>Hazard rates are defined with annual frequency and continuous compounding. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9ea9cd8b6b75f0c6e5ed1d907dfe63e1"></a><!-- doxytag: member="QuantLib::HazardRateStructure::survivalProbabilityImpl" ref="a9ea9cd8b6b75f0c6e5ed1d907dfe63e1" args="(Time) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gad9817a6a21dfcb91429f0152c99d6313">Probability</a> <a class="el" href="class_quant_lib_1_1_hazard_rate_structure.html#a9ea9cd8b6b75f0c6e5ed1d907dfe63e1">survivalProbabilityImpl</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>survival probability calculation implemented in terms of the hazard rate <img class="formulaInl" alt="$ h(t) $" src="form_369.png"/> as </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ S(t) = \exp\left( - \int_0^t h(\tau) d\tau \right). \]" src="form_370.png"/>
</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000109">Warning:</a></b></dt><dd>This default implementation uses numerical integration, which might be inefficient and inaccurate. Derived classes should override it if a more efficient implementation is available. </dd></dl>
<p>Implements <a class="el" href="class_quant_lib_1_1_default_probability_term_structure.html#a344fea84748c884236cd26be3f3b1dd5">DefaultProbabilityTermStructure</a>.</p>
<p>Reimplemented in <a class="el" href="class_quant_lib_1_1_interpolated_hazard_rate_curve.html#a9ea9cd8b6b75f0c6e5ed1d907dfe63e1">InterpolatedHazardRateCurve< Interpolator ></a>.</p>
</div>
</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>
|