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 162
|
<!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: DiscretizedDiscountBond 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_discretized_discount_bond.html">DiscretizedDiscountBond</a></div>
<h1>DiscretizedDiscountBond Class Reference</h1><!-- doxytag: class="QuantLib::DiscretizedDiscountBond" --><!-- doxytag: inherits="QuantLib::DiscretizedAsset" --><code>#include <ql/discretizedasset.hpp></code>
<p>
Inheritance diagram for DiscretizedDiscountBond:<p><center><img src="class_quant_lib_1_1_discretized_discount_bond__inherit__graph.png" border="0" usemap="#_discretized_discount_bond__inherit__map" alt="Inheritance graph"></center>
<map name="_discretized_discount_bond__inherit__map">
<area href="class_quant_lib_1_1_discretized_asset.html" shape="rect" coords="33,7,167,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_quant_lib_1_1_discretized_discount_bond-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Useful discretized discount bond asset.
<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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_discretized_discount_bond.html#1142d869230e14e04fc5d755b9b15e52">reset</a> (Size size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< <a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_discretized_discount_bond.html#264dde8c964461f44e642bc6ae8fb0e0">mandatoryTimes</a> () const</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1142d869230e14e04fc5d755b9b15e52"></a><!-- doxytag: member="QuantLib::DiscretizedDiscountBond::reset" ref="1142d869230e14e04fc5d755b9b15e52" args="(Size size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void reset </td>
<td>(</td>
<td class="paramtype">Size </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method should initialize the asset values to an <a class="el" href="class_quant_lib_1_1_array.html">Array</a> of the given size and with values depending on the particular asset.
<p>
Implements <a class="el" href="class_quant_lib_1_1_discretized_asset.html#95238187618927d950bb01e363f772dd">DiscretizedAsset</a>.
</div>
</div><p>
<a class="anchor" name="264dde8c964461f44e642bc6ae8fb0e0"></a><!-- doxytag: member="QuantLib::DiscretizedDiscountBond::mandatoryTimes" ref="264dde8c964461f44e642bc6ae8fb0e0" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<<a class="el" href="group__types.html#g14fb8fca43a68f4168654e1f9f7e22f7">Time</a>> mandatoryTimes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method returns the times at which the numerical method should stop while rolling back the asset. Typical examples include payment times, exercise times and such.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The returned values are not guaranteed to be sorted. </dd></dl>
<p>
Implements <a class="el" href="class_quant_lib_1_1_discretized_asset.html#520fddc06253daaf88dc7420a9816a94">DiscretizedAsset</a>.
</div>
</div><p>
</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>
|