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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
<!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: Debugging macros</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>Debugging macros<br>
<small>
[<a class="el" href="group__macros.html">QuantLib macros</a>]</small>
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
For debugging purposes, macros can be used to output information about the code being executed.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="group__debug_macros.html#g69b168aeab2ef4ff9033469b8214a279">QL_TRACE_ENABLE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">enable tracing <a href="#g69b168aeab2ef4ff9033469b8214a279"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g7d42ce8732ee6ca70a9c15a56f0049e1">QL_TRACE_DISABLE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">disable tracing <a href="#g7d42ce8732ee6ca70a9c15a56f0049e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g0fc8fb98e72d1a8357ead633a5d53163">QL_TRACE_ON</a>(out)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set tracing stream <a href="#g0fc8fb98e72d1a8357ead633a5d53163"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g456b5371fdc64479d393a04b505df5d0">QL_TRACE</a>(message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output tracing information <a href="#g456b5371fdc64479d393a04b505df5d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g903ea9f035842ee3560fd787c84887d7">QL_TRACE_ENTER_FUNCTION</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output tracing information <a href="#g903ea9f035842ee3560fd787c84887d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g33c013fea8c974f6781441deaa3ea53b">QL_TRACE_EXIT_FUNCTION</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output tracing information <a href="#g33c013fea8c974f6781441deaa3ea53b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g4b80d6b6b9d0d17493ac81428934f1c0">QL_TRACE_LOCATION</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output tracing information <a href="#g4b80d6b6b9d0d17493ac81428934f1c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug_macros.html#g7d82587448e3f5531f79cfb215b905af">QL_TRACE_VARIABLE</a>(variable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output tracing information <a href="#g7d82587448e3f5531f79cfb215b905af"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="g69b168aeab2ef4ff9033469b8214a279"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_ENABLE" ref="g69b168aeab2ef4ff9033469b8214a279" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_ENABLE </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
enable tracing
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g69b168aeab2ef4ff9033469b8214a279" title="enable tracing">QL_TRACE_ENABLE</a>;
</pre></div> can be used to enable tracing. Such statement might be ignored; refer to QL_TRACE for details. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tracing__example_8cpp-example.html#a5">tracing_example.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g7d42ce8732ee6ca70a9c15a56f0049e1"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_DISABLE" ref="g7d42ce8732ee6ca70a9c15a56f0049e1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_DISABLE </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
disable tracing
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g7d42ce8732ee6ca70a9c15a56f0049e1" title="disable tracing">QL_TRACE_DISABLE</a>;
</pre></div> can be used to disable tracing. Such statement might be ignored; refer to QL_TRACE for details.
</div>
</div><p>
<a class="anchor" name="g0fc8fb98e72d1a8357ead633a5d53163"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_ON" ref="g0fc8fb98e72d1a8357ead633a5d53163" args="(out)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_ON </td>
<td>(</td>
<td class="paramtype">out </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
set tracing stream
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g0fc8fb98e72d1a8357ead633a5d53163" title="set tracing stream">QL_TRACE_ON</a>(stream);
</pre></div> can be used to set the stream where tracing messages are output. Such statement might be ignored; refer to QL_TRACE for details.
</div>
</div><p>
<a class="anchor" name="g456b5371fdc64479d393a04b505df5d0"></a><!-- doxytag: member="tracing.hpp::QL_TRACE" ref="g456b5371fdc64479d393a04b505df5d0" args="(message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE </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>
output tracing information
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g456b5371fdc64479d393a04b505df5d0" title="output tracing information">QL_TRACE</a>(message);
</pre></div> can be used to output a trace of the code being executed. If tracing was disabled during configuration, such statements are removed by the preprocessor for maximum performance; if it was enabled, whether and where the message is output depends on the current settings. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tracing__example_8cpp-example.html#a3">tracing_example.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g903ea9f035842ee3560fd787c84887d7"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_ENTER_FUNCTION" ref="g903ea9f035842ee3560fd787c84887d7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_ENTER_FUNCTION </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output tracing information
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g903ea9f035842ee3560fd787c84887d7" title="output tracing information">QL_TRACE_ENTER_FUNCTION</a>;
</pre></div> can be used at the beginning of a function to trace the fact that the program execution is entering such function. It should be paired with a corresponding QL_TRACE_EXIT_FUNCTION macro. Such statement might be ignored; refer to QL_TRACE for details. Also, function information might not be available depending on the compiler. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tracing__example_8cpp-example.html#a0">tracing_example.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g33c013fea8c974f6781441deaa3ea53b"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_EXIT_FUNCTION" ref="g33c013fea8c974f6781441deaa3ea53b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_EXIT_FUNCTION </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output tracing information
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g33c013fea8c974f6781441deaa3ea53b" title="output tracing information">QL_TRACE_EXIT_FUNCTION</a>;
</pre></div> can be used before returning from a function to trace the fact that the program execution is exiting such function. It should be paired with a corresponding QL_TRACE_ENTER_FUNCTION macro. Such statement might be ignored; refer to QL_TRACE for details. Also, function information might not be available depending on the compiler. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tracing__example_8cpp-example.html#a4">tracing_example.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g4b80d6b6b9d0d17493ac81428934f1c0"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_LOCATION" ref="g4b80d6b6b9d0d17493ac81428934f1c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_LOCATION </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output tracing information
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g4b80d6b6b9d0d17493ac81428934f1c0" title="output tracing information">QL_TRACE_LOCATION</a>;
</pre></div> can be used to trace the current file and line. Such statement might be ignored; refer to QL_TRACE for details. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tracing__example_8cpp-example.html#a2">tracing_example.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g7d82587448e3f5531f79cfb215b905af"></a><!-- doxytag: member="tracing.hpp::QL_TRACE_VARIABLE" ref="g7d82587448e3f5531f79cfb215b905af" args="(variable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QL_TRACE_VARIABLE </td>
<td>(</td>
<td class="paramtype">variable </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output tracing information
<p>
The statement <div class="fragment"><pre class="fragment"> <a class="code" href="group__debug_macros.html#g7d82587448e3f5531f79cfb215b905af" title="output tracing information">QL_TRACE_VARIABLE</a>(variable);
</pre></div> can be used to trace the current value of a variable. Such statement might be ignored; refer to QL_TRACE for details. Also, the variable type must allow sending it to an output stream. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tracing__example_8cpp-example.html#a1">tracing_example.cpp</a>.</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>
|
