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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
<!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: Output manipulators</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>Output manipulators</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Helper functions for creating formatted output.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::short_date_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gb9e306f9ec0855319cbb452f6a7b3627">short_date</a> (const Date &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output dates in short format (mm/dd/yyyy) <a href="#gb9e306f9ec0855319cbb452f6a7b3627"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::long_date_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gd2cba1797c1cf63c02d899696b343ee8">long_date</a> (const Date &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output dates in long format (Month ddth, yyyy) <a href="#gd2cba1797c1cf63c02d899696b343ee8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::iso_date_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g0921b3ae46195feff93b2a4388e05d63">iso_date</a> (const Date &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output dates in ISO format (yyyy-mm-dd) <a href="#g0921b3ae46195feff93b2a4388e05d63"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::long_period_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g21b63d20c9f70f1d56fe664a5d10932e">long_period</a> (const Period &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output periods in long format (e.g. "2 weeks") <a href="#g21b63d20c9f70f1d56fe664a5d10932e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::short_period_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gfd478859146a0e3cdb97a51a4f7839a3">short_period</a> (const Period &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output periods in short format (e.g. "2w") <a href="#gfd478859146a0e3cdb97a51a4f7839a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::long_weekday_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gd167f4e6391385217e46dfa4827884bc">long_weekday</a> (Weekday)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output weekdays in long format <a href="#gd167f4e6391385217e46dfa4827884bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::short_weekday_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g5be437350e5e56a699ba0f53bf25b2ce">short_weekday</a> (Weekday)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output weekdays in short format (three letters) <a href="#g5be437350e5e56a699ba0f53bf25b2ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">detail::shortest_weekday_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g951de1277920bcbcfb757a4f5a254d03">shortest_weekday</a> (Weekday)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output weekdays in shortest format (two letters) <a href="#g951de1277920bcbcfb757a4f5a254d03"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g964f8fcdcdbcc6ef271a8f2c06d6c3a1"></a><!-- doxytag: member="manips::checknull" ref="g964f8fcdcdbcc6ef271a8f2c06d6c3a1" args="(T)" -->
template<typename T> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">detail::null_checker< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__manips.html#g964f8fcdcdbcc6ef271a8f2c06d6c3a1">checknull</a> (T)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">check for nulls before output <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gce46b8e41fd72ee71b9ca53cafd0277f"></a><!-- doxytag: member="manips::ordinal" ref="gce46b8e41fd72ee71b9ca53cafd0277f" args="(Size)" -->
detail::ordinal_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gce46b8e41fd72ee71b9ca53cafd0277f">ordinal</a> (Size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">outputs naturals as 1st, 2nd, 3rd... <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g3497dcad1b0ed0e1dab123204e381988"></a><!-- doxytag: member="manips::power_of_two" ref="g3497dcad1b0ed0e1dab123204e381988" args="(T)" -->
template<typename T> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">detail::power_of_two_holder< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__manips.html#g3497dcad1b0ed0e1dab123204e381988">power_of_two</a> (T)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output integers as powers of two <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge524bfb28ff5254a99ba5a4e778aee29"></a><!-- doxytag: member="manips::percent" ref="ge524bfb28ff5254a99ba5a4e778aee29" args="(Real)" -->
detail::percent_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#ge524bfb28ff5254a99ba5a4e778aee29">percent</a> (Real)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output reals as percentages <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc63ea3dad10259db3764c7d15a61cde5"></a><!-- doxytag: member="manips::rate" ref="gc63ea3dad10259db3764c7d15a61cde5" args="(Rate)" -->
detail::percent_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gc63ea3dad10259db3764c7d15a61cde5">rate</a> (Rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output rates and spreads as percentages <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc402ef7c87f63f7c603ee87210b5750c"></a><!-- doxytag: member="manips::volatility" ref="gc402ef7c87f63f7c603ee87210b5750c" args="(Volatility)" -->
detail::percent_holder </td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gc402ef7c87f63f7c603ee87210b5750c">volatility</a> (Volatility)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">output volatilities as percentages <br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gb9e306f9ec0855319cbb452f6a7b3627"></a><!-- doxytag: member="QuantLib::io::short_date" ref="gb9e306f9ec0855319cbb452f6a7b3627" args="(const Date &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::short_date_holder QuantLib::io::short_date </td>
<td>(</td>
<td class="paramtype">const Date & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output dates in short format (mm/dd/yyyy)
<p>
</div>
</div><p>
<a class="anchor" name="gd2cba1797c1cf63c02d899696b343ee8"></a><!-- doxytag: member="QuantLib::io::long_date" ref="gd2cba1797c1cf63c02d899696b343ee8" args="(const Date &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::long_date_holder QuantLib::io::long_date </td>
<td>(</td>
<td class="paramtype">const Date & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output dates in long format (Month ddth, yyyy)
<p>
</div>
</div><p>
<a class="anchor" name="g0921b3ae46195feff93b2a4388e05d63"></a><!-- doxytag: member="QuantLib::io::iso_date" ref="g0921b3ae46195feff93b2a4388e05d63" args="(const Date &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::iso_date_holder QuantLib::io::iso_date </td>
<td>(</td>
<td class="paramtype">const Date & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output dates in ISO format (yyyy-mm-dd)
<p>
</div>
</div><p>
<a class="anchor" name="g21b63d20c9f70f1d56fe664a5d10932e"></a><!-- doxytag: member="QuantLib::io::long_period" ref="g21b63d20c9f70f1d56fe664a5d10932e" args="(const Period &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::long_period_holder QuantLib::io::long_period </td>
<td>(</td>
<td class="paramtype">const Period & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output periods in long format (e.g. "2 weeks")
<p>
</div>
</div><p>
<a class="anchor" name="gfd478859146a0e3cdb97a51a4f7839a3"></a><!-- doxytag: member="QuantLib::io::short_period" ref="gfd478859146a0e3cdb97a51a4f7839a3" args="(const Period &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::short_period_holder QuantLib::io::short_period </td>
<td>(</td>
<td class="paramtype">const Period & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output periods in short format (e.g. "2w")
<p>
</div>
</div><p>
<a class="anchor" name="gd167f4e6391385217e46dfa4827884bc"></a><!-- doxytag: member="QuantLib::io::long_weekday" ref="gd167f4e6391385217e46dfa4827884bc" args="(Weekday)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::long_weekday_holder QuantLib::io::long_weekday </td>
<td>(</td>
<td class="paramtype">Weekday </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output weekdays in long format
<p>
</div>
</div><p>
<a class="anchor" name="g5be437350e5e56a699ba0f53bf25b2ce"></a><!-- doxytag: member="QuantLib::io::short_weekday" ref="g5be437350e5e56a699ba0f53bf25b2ce" args="(Weekday)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::short_weekday_holder QuantLib::io::short_weekday </td>
<td>(</td>
<td class="paramtype">Weekday </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output weekdays in short format (three letters)
<p>
</div>
</div><p>
<a class="anchor" name="g951de1277920bcbcfb757a4f5a254d03"></a><!-- doxytag: member="QuantLib::io::shortest_weekday" ref="g951de1277920bcbcfb757a4f5a254d03" args="(Weekday)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::shortest_weekday_holder QuantLib::io::shortest_weekday </td>
<td>(</td>
<td class="paramtype">Weekday </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
output weekdays in shortest format (two letters)
<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>
|
