File: group__manips.html

package info (click to toggle)
quantlib-refman-html 0.3.14-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 43,500 kB
  • ctags: 8,975
  • sloc: makefile: 31
file content (163 lines) | stat: -rw-r--r-- 11,219 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<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.3.14</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="faq.html">Frequently asked questions</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="deprecated.html">Deprecated Features</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.1 -->
<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"><a class="anchor" name="gd167f4e6391385217e46dfa4827884bc"></a><!-- doxytag: member="manips::long_weekday" ref="gd167f4e6391385217e46dfa4827884bc" args="(Weekday)" -->
detail::long_weekday_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gd167f4e6391385217e46dfa4827884bc">long_weekday</a> (Weekday)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output weekdays in long format <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5be437350e5e56a699ba0f53bf25b2ce"></a><!-- doxytag: member="manips::short_weekday" ref="g5be437350e5e56a699ba0f53bf25b2ce" args="(Weekday)" -->
detail::short_weekday_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g5be437350e5e56a699ba0f53bf25b2ce">short_weekday</a> (Weekday)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output weekdays in short format (three letters) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g951de1277920bcbcfb757a4f5a254d03"></a><!-- doxytag: member="manips::shortest_weekday" ref="g951de1277920bcbcfb757a4f5a254d03" args="(Weekday)" -->
detail::shortest_weekday_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g951de1277920bcbcfb757a4f5a254d03">shortest_weekday</a> (Weekday)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output weekdays in shortest format (two letters) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb9e306f9ec0855319cbb452f6a7b3627"></a><!-- doxytag: member="manips::short_date" ref="gb9e306f9ec0855319cbb452f6a7b3627" args="(const Date &amp;)" -->
detail::short_date_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gb9e306f9ec0855319cbb452f6a7b3627">short_date</a> (const Date &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output dates in short format (mm/dd/yyyy) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd2cba1797c1cf63c02d899696b343ee8"></a><!-- doxytag: member="manips::long_date" ref="gd2cba1797c1cf63c02d899696b343ee8" args="(const Date &amp;)" -->
detail::long_date_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gd2cba1797c1cf63c02d899696b343ee8">long_date</a> (const Date &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output dates in long format (Month ddth, yyyy) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0921b3ae46195feff93b2a4388e05d63"></a><!-- doxytag: member="manips::iso_date" ref="g0921b3ae46195feff93b2a4388e05d63" args="(const Date &amp;)" -->
detail::iso_date_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g0921b3ae46195feff93b2a4388e05d63">iso_date</a> (const Date &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output dates in ISO format (yyyy-mm-dd) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g21b63d20c9f70f1d56fe664a5d10932e"></a><!-- doxytag: member="manips::long_period" ref="g21b63d20c9f70f1d56fe664a5d10932e" args="(const Period &amp;)" -->
detail::long_period_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#g21b63d20c9f70f1d56fe664a5d10932e">long_period</a> (const Period &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output periods in long format (e.g. "2 weeks") <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd478859146a0e3cdb97a51a4f7839a3"></a><!-- doxytag: member="manips::short_period" ref="gfd478859146a0e3cdb97a51a4f7839a3" args="(const Period &amp;)" -->
detail::short_period_holder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gfd478859146a0e3cdb97a51a4f7839a3">short_period</a> (const Period &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output periods in short format (e.g. "2w") <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&lt;typename T&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">detail::null_checker&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__manips.html#g964f8fcdcdbcc6ef271a8f2c06d6c3a1">checknull</a> (T)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gce46b8e41fd72ee71b9ca53cafd0277f">ordinal</a> (Size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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&lt;typename T&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">detail::power_of_two_holder&lt;<br>
 T &gt;&nbsp;</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">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#ge524bfb28ff5254a99ba5a4e778aee29">percent</a> (Real)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gc63ea3dad10259db3764c7d15a61cde5">rate</a> (Rate)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__manips.html#gc402ef7c87f63f7c603ee87210b5750c">volatility</a> (Volatility)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">output volatilities as percentages <br></td></tr>
</table>

</div>

<div class="footer">

<table align="top" width="100%">
<tr>
<td align="middle" width="33%">
<strong>QuantLib.org</strong><br>
<a href="http://quantlib.org/">
<img src="QL-small.jpg" alt="QuantLib" align="middle" border=0>
</a>
</td>
<td align="middle" width="33%">
<strong>Hosted by</strong><br>
<a href="http://sourceforge.net"><img src=
"sfnetlogo.png" width="88" height="31"
border="0" alt="SourceForge.net Logo"></a>
</td>
<td align="middle" width="33%">
<strong>Documentation generated by</strong><br>
<a href="http://www.doxygen.org">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53>
</a></td>
</tr>
</table>
</div>

</div>

</body>
</html>