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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<!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: ql/errors.hpp File 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 -->
<h1>ql/errors.hpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Classes and functions for error handling.
<p>
<p>
<code>#include <<a class="el" href="qldefines_8hpp.html">ql/qldefines.hpp</a>></code><br>
<code>#include <boost/assert.hpp></code><br>
<code>#include <boost/current_function.hpp></code><br>
<code>#include <boost/shared_ptr.hpp></code><br>
<code>#include <exception></code><br>
<code>#include <sstream></code><br>
<p>
<div class="dynheader">
Include dependency graph for errors.hpp:</div>
<div class="dynsection">
<p><center><img src="errors_8hpp__incl.png" border="0" usemap="#ql/errors.hpp_map" alt=""></center>
<map name="ql/errors.hpp_map">
<area shape="rect" href="qldefines_8hpp.html" title="Global definitions and compiler switches." alt="" coords="5,84,125,111"></map>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_quant_lib.html">QuantLib</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_error.html">Error</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base error class. <a href="class_quant_lib_1_1_error.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="errors_8hpp.html#8efe9cb3e67c8d0585e57b4d53c5d2fe">QL_FAIL</a>(message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">throw an error (possibly with file and line information) <a href="#8efe9cb3e67c8d0585e57b4d53c5d2fe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="errors_8hpp.html#94f8e06a99bc5ff11e2b4c369ba43193">QL_ASSERT</a>(condition, message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">throw an error if the given condition is not verified <a href="#94f8e06a99bc5ff11e2b4c369ba43193"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="errors_8hpp.html#7a9bcab8006882bc7d5302a0861ab1a6">QL_REQUIRE</a>(condition, message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">throw an error if the given pre-condition is not verified <a href="#7a9bcab8006882bc7d5302a0861ab1a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="errors_8hpp.html#394b39aa396098345f86d243f207f7af">QL_ENSURE</a>(condition, message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">throw an error if the given post-condition is not verified <a href="#394b39aa396098345f86d243f207f7af"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="8efe9cb3e67c8d0585e57b4d53c5d2fe"></a><!-- doxytag: member="errors.hpp::QL_FAIL" ref="8efe9cb3e67c8d0585e57b4d53c5d2fe" args="(message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_FAIL </td>
<td>(</td>
<td class="paramtype">message </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">do</span> { \
std::ostringstream _ql_msg_stream; \
_ql_msg_stream << message; \
<span class="keywordflow">throw</span> <a class="code" href="class_quant_lib_1_1_error.html" title="Base error class.">QuantLib::Error</a>(__FILE__,__LINE__, \
BOOST_CURRENT_FUNCTION,_ql_msg_stream.str()); \
} <span class="keywordflow">while</span> (<span class="keyword">false</span>)
</pre></div>throw an error (possibly with file and line information)
<p>
</div>
</div><p>
<a class="anchor" name="94f8e06a99bc5ff11e2b4c369ba43193"></a><!-- doxytag: member="errors.hpp::QL_ASSERT" ref="94f8e06a99bc5ff11e2b4c369ba43193" args="(condition, message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_ASSERT </td>
<td>(</td>
<td class="paramtype">condition, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">message </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (!(condition)) { \
std::ostringstream _ql_msg_stream; \
_ql_msg_stream << message; \
<span class="keywordflow">throw</span> <a class="code" href="class_quant_lib_1_1_error.html" title="Base error class.">QuantLib::Error</a>(__FILE__,__LINE__, \
BOOST_CURRENT_FUNCTION,_ql_msg_stream.str()); \
} <span class="keywordflow">else</span>
</pre></div>throw an error if the given condition is not verified
<p>
</div>
</div><p>
<a class="anchor" name="7a9bcab8006882bc7d5302a0861ab1a6"></a><!-- doxytag: member="errors.hpp::QL_REQUIRE" ref="7a9bcab8006882bc7d5302a0861ab1a6" args="(condition, message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_REQUIRE </td>
<td>(</td>
<td class="paramtype">condition, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">message </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (!(condition)) { \
std::ostringstream _ql_msg_stream; \
_ql_msg_stream << message; \
<span class="keywordflow">throw</span> <a class="code" href="class_quant_lib_1_1_error.html" title="Base error class.">QuantLib::Error</a>(__FILE__,__LINE__, \
BOOST_CURRENT_FUNCTION,_ql_msg_stream.str()); \
} <span class="keywordflow">else</span>
</pre></div>throw an error if the given pre-condition is not verified
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_discrete_hedging_8cpp-example.html#a10">DiscreteHedging.cpp</a>, and <a class="el" href="swapvaluation_8cpp-example.html#a33">swapvaluation.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="394b39aa396098345f86d243f207f7af"></a><!-- doxytag: member="errors.hpp::QL_ENSURE" ref="394b39aa396098345f86d243f207f7af" args="(condition, message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_ENSURE </td>
<td>(</td>
<td class="paramtype">condition, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">message </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (!(condition)) { \
std::ostringstream _ql_msg_stream; \
_ql_msg_stream << message; \
<span class="keywordflow">throw</span> <a class="code" href="class_quant_lib_1_1_error.html" title="Base error class.">QuantLib::Error</a>(__FILE__,__LINE__, \
BOOST_CURRENT_FUNCTION,_ql_msg_stream.str()); \
} <span class="keywordflow">else</span>
</pre></div>throw an error if the given post-condition is not verified
<p>
</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>
|
