File: class_quant_lib_1_1_fixed_rate_bond_helper.html

package info (click to toggle)
quantlib-refman-html 0.9.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 60,592 kB
  • ctags: 7,595
  • sloc: makefile: 30
file content (147 lines) | stat: -rw-r--r-- 11,783 bytes parent folder | download
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
<!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: FixedRateBondHelper 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_fixed_rate_bond_helper.html">FixedRateBondHelper</a></div>
<h1>FixedRateBondHelper Class Reference</h1><!-- doxytag: class="QuantLib::FixedRateBondHelper" --><!-- doxytag: inherits="QuantLib::BootstrapHelper" --><code>#include &lt;ql/termstructures/yield/bondhelpers.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for FixedRateBondHelper:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_fixed_rate_bond_helper__inherit__graph.png" border="0" usemap="#_fixed_rate_bond_helper__inherit__map" alt="Inheritance graph"></center>
<map name="_fixed_rate_bond_helper__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_bootstrap_helper.html" title="Base helper class for bootstrapping." alt="" coords="5,7,352,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="class_quant_lib_1_1_fixed_rate_bond_helper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
fixed-coupon bond helper 
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000102">Warning:</a></b></dt><dd>This class assumes that the reference date does not change between calls of setTermStructure(). </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="_fitted_bond_curve_8cpp-example.html#_a19">FittedBondCurve.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="d37a52533799aade41158053cc698a64"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::FixedRateBondHelper" ref="d37a52533799aade41158053cc698a64" args="(const Handle&lt; Quote &gt; &amp;cleanPrice, Natural settlementDays, const Schedule &amp;schedule, const std::vector&lt; Rate &gt; &amp;coupons, const DayCounter &amp;paymentDayCounter, BusinessDayConvention paymentConvention=Following, Real redemption=100.0, const Date &amp;issueDate=Date())" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FixedRateBondHelper</b> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_quote.html">Quote</a> &gt; &amp;cleanPrice, <a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a> settlementDays, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &amp;schedule, const std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt; &amp;coupons, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;paymentDayCounter, <a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> paymentConvention=Following, <a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> redemption=100.0, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &amp;issueDate=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9c69887bf51d43666aa7d5edfe124c0a"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::impliedQuote" ref="9c69887bf51d43666aa7d5edfe124c0a" args="() const " -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>impliedQuote</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="128a17ae0d2d2b95a63f9c3f49d44c31"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::setTermStructure" ref="128a17ae0d2d2b95a63f9c3f49d44c31" args="(YieldTermStructure *)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setTermStructure</b> (<a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8762d82de69fd8d564bac6327af14259"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::bond" ref="8762d82de69fd8d564bac6327af14259" args="() const " -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_fixed_rate_bond.html">FixedRateBond</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bond</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="677cd8177f9f43a90321e2a7cea44b00"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::dayCounter" ref="677cd8177f9f43a90321e2a7cea44b00" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>dayCounter</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70fafd3d3f212d824101e977784dbcf5"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::frequency" ref="70fafd3d3f212d824101e977784dbcf5" args="() const " -->
<a class="el" href="group__datetime.html#g6d41db8ba0ea90d22df35889df452ada">Frequency</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>frequency</b> () const </td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8cb58608de54286272715a08a7492a7e"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::settlementDays_" ref="8cb58608de54286272715a08a7492a7e" args="" -->
<a class="el" href="group__types.html#g7e529c39c477ba1f5a22264d93e8457a">Natural</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>settlementDays_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="070ed82c6cab5f05e2874979f4193388"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::schedule_" ref="070ed82c6cab5f05e2874979f4193388" args="" -->
<a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>schedule_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b2c449509efe4ef1d8108c4136227c6"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::coupons_" ref="0b2c449509efe4ef1d8108c4136227c6" args="" -->
std::vector&lt; <a class="el" href="group__types.html#gede435af51236692b1107d7639581d39">Rate</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>coupons_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb22873f87d413d6123c023880f8938f"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::paymentDayCounter_" ref="fb22873f87d413d6123c023880f8938f" args="" -->
<a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>paymentDayCounter_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0c2ba6da16ec8c201da972e61b08334"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::paymentConvention_" ref="b0c2ba6da16ec8c201da972e61b08334" args="" -->
<a class="el" href="group__datetime.html#gff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>paymentConvention_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da8aca1dd8c0ade1c41c216226d21a41"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::redemption_" ref="da8aca1dd8c0ade1c41c216226d21a41" args="" -->
<a class="el" href="group__types.html#g4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>redemption_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a99ac89090fd236a5d29db55f21003a9"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::issueDate_" ref="a99ac89090fd236a5d29db55f21003a9" args="" -->
<a class="el" href="class_quant_lib_1_1_date.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>issueDate_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e9d971f47f7933fa80d92c51949cbef"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::bond_" ref="7e9d971f47f7933fa80d92c51949cbef" args="" -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_fixed_rate_bond.html">FixedRateBond</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bond_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e8f394e2be5705b297a1316eea82056"></a><!-- doxytag: member="QuantLib::FixedRateBondHelper::termStructureHandle_" ref="2e8f394e2be5705b297a1316eea82056" args="" -->
<a class="el" href="class_quant_lib_1_1_relinkable_handle.html">RelinkableHandle</a><br>
&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>termStructureHandle_</b></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>