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
163
164
165
166
167
168
169
170
171
172
173
174
|
<!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: Handle Class Template 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_handle.html">Handle</a></div>
<h1>Handle Class Template Reference</h1><!-- doxytag: class="QuantLib::Handle" --><code>#include <ql/handle.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Handle:</div>
<div class="dynsection">
<p><center><img src="class_quant_lib_1_1_handle__inherit__graph.png" border="0" usemap="#_handle__inherit__map" alt="Inheritance graph"></center>
<map name="_handle__inherit__map">
<area shape="rect" href="class_quant_lib_1_1_relinkable_handle.html" title="Relinkable handle to an observable." alt="" coords="5,84,171,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="class_quant_lib_1_1_handle-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br>
class QuantLib::Handle< T ></h3>
Shared handle to an observable.
<p>
All copies of an instance of this class refer to the same observable by means of a relinkable smart pointer. When such pointer is relinked to another observable, the change will be propagated to all the copies.<p>
<dl class="pre" compact><dt><b>Precondition:</b></dt><dd>Class T must inherit from <a class="el" href="class_quant_lib_1_1_observable.html" title="Object that notifies its changes to a set of observables.">Observable</a> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="_bermudan_swaption_8cpp-example.html#_a11">BermudanSwaption.cpp</a>, <a class="el" href="_convertible_bonds_8cpp-example.html#_a28">ConvertibleBonds.cpp</a>, <a class="el" href="_discrete_hedging_8cpp-example.html#_a20">DiscreteHedging.cpp</a>, <a class="el" href="_equity_option_8cpp-example.html#_a16">EquityOption.cpp</a>, <a class="el" href="_replication_8cpp-example.html#_a8">Replication.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#_a13">swapvaluation.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#ce4091c8f9c1f91c0489464712820bf9">Handle</a> (const boost::shared_ptr< T > &h=boost::shared_ptr< T >(), bool registerAsObserver=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4a6670fe9c581ee1415114296e6688f"></a><!-- doxytag: member="QuantLib::Handle::currentLink" ref="b4a6670fe9c581ee1415114296e6688f" args="() const " -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#b4a6670fe9c581ee1415114296e6688f">currentLink</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">dereferencing <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7f131d2a22209986c1097a8495d20ba"></a><!-- doxytag: member="QuantLib::Handle::operator->" ref="a7f131d2a22209986c1097a8495d20ba" args="() const " -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><b>operator-></b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81f5c87f8476f01c04b097609b2dcc6d"></a><!-- doxytag: member="QuantLib::Handle::operator *" ref="81f5c87f8476f01c04b097609b2dcc6d" args="() const " -->
const boost::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><b>operator *</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6e61de369e994009e36f344f99c15ad"></a><!-- doxytag: member="QuantLib::Handle::empty" ref="c6e61de369e994009e36f344f99c15ad" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#c6e61de369e994009e36f344f99c15ad">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">checks if the contained shared pointer points to anything <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0b3ed61a44036fb7b305892a1546385"></a><!-- doxytag: member="QuantLib::Handle::operator boost::shared_ptr< Observable >" ref="c0b3ed61a44036fb7b305892a1546385" args="() const " -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#c0b3ed61a44036fb7b305892a1546385">operator boost::shared_ptr< Observable ></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allows registration as observable <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="e798035ab9e834a54fbf60ce3cfa5345"></a><!-- doxytag: member="QuantLib::Handle::operator==" ref="e798035ab9e834a54fbf60ce3cfa5345" args="(const Handle< U > &other)" -->
template<class U> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#e798035ab9e834a54fbf60ce3cfa5345">operator==</a> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< U > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">equality test <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="cf4b08ef10da5bface7a3cfd7a22d743"></a><!-- doxytag: member="QuantLib::Handle::operator!=" ref="cf4b08ef10da5bface7a3cfd7a22d743" args="(const Handle< U > &other)" -->
template<class U> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#cf4b08ef10da5bface7a3cfd7a22d743">operator!=</a> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< U > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">disequality test <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="77f12a71721e1aa5744a4a3190c327c1"></a><!-- doxytag: member="QuantLib::Handle::operator<" ref="77f12a71721e1aa5744a4a3190c327c1" args="(const Handle< U > &other)" -->
template<class U> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_handle.html#77f12a71721e1aa5744a4a3190c327c1">operator<</a> (const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>< U > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">strict weak ordering <br></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="082f4b0854913f436256f61ddb0c3769"></a><!-- doxytag: member="QuantLib::Handle::link_" ref="082f4b0854913f436256f61ddb0c3769" args="" -->
boost::shared_ptr< Link > </td><td class="memItemRight" valign="bottom"><b>link_</b></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ce4091c8f9c1f91c0489464712820bf9"></a><!-- doxytag: member="QuantLib::Handle::Handle" ref="ce4091c8f9c1f91c0489464712820bf9" args="(const boost::shared_ptr< T > &h=boost::shared_ptr< T >(), bool registerAsObserver=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_handle.html">Handle</a> </td>
<td>(</td>
<td class="paramtype">const boost::shared_ptr< T > & </td>
<td class="paramname"> <em>h</em> = <code>boost::shared_ptr<T>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>registerAsObserver</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="caveats.html#_caveats000009">Warning:</a></b></dt><dd><code>registerAsObserver</code> is left as a backdoor in case the programmer cannot guarantee that the object pointed to will remain alive for the whole lifetime of the handle---namely, it should be set to <code>false</code> when the passed shared pointer does not own the pointee (this should only happen in a controlled environment, so that the programmer is aware of it). Failure to do so can very likely result in a program crash. If the programmer does want the handle to register as observer of such a shared pointer, it is his responsibility to ensure that the handle gets destroyed before the pointed object does. </dd></dl>
</div>
</div><p>
</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>
|
