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>BondHelper 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_bond_helper.html">BondHelper</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">BondHelper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::BondHelper" --><!-- doxytag: inherits="QuantLib::BootstrapHelper" -->
<p>fixed-coupon bond helper
<a href="class_quant_lib_1_1_bond_helper.html#details">More...</a></p>
<p><code>#include <ql/termstructures/yield/bondhelpers.hpp></code></p>
<div class="dynheader">
Inheritance diagram for BondHelper:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_bond_helper__inherit__graph.png" border="0" usemap="#_bond_helper_inherit__map" alt="Inheritance graph"/></div>
<map name="_bond_helper_inherit__map" id="_bond_helper_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_bootstrap_helper.html" title="Base helper class for bootstrapping." alt="" coords="7,6,92,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_quant_lib_1_1_bond_helper-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 class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_bond_helper.html#af4868f10939da98e59cac5ed15f5d922">BondHelper</a> (const <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> > &cleanPrice, const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_bond.html">Bond</a> > &bond)</td></tr>
<tr><td colspan="2"><div class="groupHeader">RateHelper interface</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c69887bf51d43666aa7d5edfe124c0a"></a><!-- doxytag: member="QuantLib::BondHelper::impliedQuote" ref="a9c69887bf51d43666aa7d5edfe124c0a" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><b>impliedQuote</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a128a17ae0d2d2b95a63f9c3f49d44c31"></a><!-- doxytag: member="QuantLib::BondHelper::setTermStructure" ref="a128a17ae0d2d2b95a63f9c3f49d44c31" args="(YieldTermStructure *)" -->
void </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 colspan="2"><div class="groupHeader">additional inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae540c55f1fe7f5011af6cf12d1c9a60d"></a><!-- doxytag: member="QuantLib::BondHelper::bond" ref="ae540c55f1fe7f5011af6cf12d1c9a60d" args="() const " -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_bond.html">Bond</a> > </td><td class="memItemRight" valign="bottom"><b>bond</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">Visitability</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d7eaf2f5dccce1c7781b54d64ba4a07"></a><!-- doxytag: member="QuantLib::BondHelper::accept" ref="a1d7eaf2f5dccce1c7781b54d64ba4a07" args="(AcyclicVisitor &)" -->
void </td><td class="memItemRight" valign="bottom"><b>accept</b> (<a class="el" href="class_quant_lib_1_1_acyclic_visitor.html">AcyclicVisitor</a> &)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4821815d418ae403f661fe086661d7da"></a><!-- doxytag: member="QuantLib::BondHelper::bond_" ref="a4821815d418ae403f661fe086661d7da" args="" -->
boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_bond.html">Bond</a> > </td><td class="memItemRight" valign="bottom"><b>bond_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e8f394e2be5705b297a1316eea82056"></a><!-- doxytag: member="QuantLib::BondHelper::termStructureHandle_" ref="a2e8f394e2be5705b297a1316eea82056" args="" -->
<a class="el" href="class_quant_lib_1_1_relinkable_handle.html">RelinkableHandle</a><br class="typebreak"/>
< <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> > </td><td class="memItemRight" valign="bottom"><b>termStructureHandle_</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>fixed-coupon bond helper </p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000133">Warning:</a></b></dt><dd>This class assumes that the reference date does not change between calls of setTermStructure(). </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af4868f10939da98e59cac5ed15f5d922"></a><!-- doxytag: member="QuantLib::BondHelper::BondHelper" ref="af4868f10939da98e59cac5ed15f5d922" args="(const Handle< Quote > &cleanPrice, const boost::shared_ptr< Bond > &bond)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_bond_helper.html">BondHelper</a> </td>
<td>(</td>
<td class="paramtype">const <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> > & </td>
<td class="paramname"><em>cleanPrice</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const boost::shared_ptr< <a class="el" href="class_quant_lib_1_1_bond.html">Bond</a> > & </td>
<td class="paramname"><em>bond</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000134">Warning:</a></b></dt><dd>Setting a pricing engine to the passed bond from external code will cause the bootstrap to fail or to give wrong results. It is advised to discard the bond after creating the helper, so that the helper has sole ownership of it. </dd></dl>
</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>
|
