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
|
<!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: LexicographicalView 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_lexicographical_view.html">LexicographicalView</a></div>
<h1>LexicographicalView Class Template Reference</h1><!-- doxytag: class="QuantLib::LexicographicalView" --><code>#include <ql/math/lexicographicalview.hpp></code>
<p>
<p>
<a href="class_quant_lib_1_1_lexicographical_view-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class RandomAccessIterator><br>
class QuantLib::LexicographicalView< RandomAccessIterator ></h3>
Lexicographical 2-D view of a contiguous set of data.
<p>
This view can be used to easily store a discretized 2-D function in an array to be used in a finite differences calculation. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60ae9a6c903bfa254d23a6a144ad05ae"></a><!-- doxytag: member="QuantLib::LexicographicalView::x_iterator" ref="60ae9a6c903bfa254d23a6a144ad05ae" args="" -->
typedef RandomAccessIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#60ae9a6c903bfa254d23a6a144ad05ae">x_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">iterates over <img class="formulaInl" alt="$ v_{ij} $" src="form_141.png"> with <img class="formulaInl" alt="$ j $" src="form_142.png"> fixed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffef015b19d72a3e5affd7f6f94c487c"></a><!-- doxytag: member="QuantLib::LexicographicalView::reverse_x_iterator" ref="ffef015b19d72a3e5affd7f6f94c487c" args="" -->
typedef <br>
boost::reverse_iterator<br>
< RandomAccessIterator > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#ffef015b19d72a3e5affd7f6f94c487c">reverse_x_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">iterates backwards over <img class="formulaInl" alt="$ v_{ij} $" src="form_141.png"> with <img class="formulaInl" alt="$ j $" src="form_142.png"> fixed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33c972ce3c11af890f66ca3fa79e4692"></a><!-- doxytag: member="QuantLib::LexicographicalView::y_iterator" ref="33c972ce3c11af890f66ca3fa79e4692" args="" -->
typedef <a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a><br>
< RandomAccessIterator > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#33c972ce3c11af890f66ca3fa79e4692">y_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">iterates over <img class="formulaInl" alt="$ v_{ij} $" src="form_141.png"> with <img class="formulaInl" alt="$ i $" src="form_60.png"> fixed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ca10f675e1e0b950cf45bb46d2ae2ad"></a><!-- doxytag: member="QuantLib::LexicographicalView::reverse_y_iterator" ref="9ca10f675e1e0b950cf45bb46d2ae2ad" args="" -->
typedef <br>
boost::reverse_iterator<br>
< <a class="el" href="class_quant_lib_1_1step__iterator.html">y_iterator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#9ca10f675e1e0b950cf45bb46d2ae2ad">reverse_y_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">iterates backwards over <img class="formulaInl" alt="$ v_{ij} $" src="form_141.png"> with <img class="formulaInl" alt="$ i $" src="form_60.png"> fixed. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64811b5cfac61b8b7f079a1e56c273f1"></a><!-- doxytag: member="QuantLib::LexicographicalView::LexicographicalView" ref="64811b5cfac61b8b7f079a1e56c273f1" args="(const RandomAccessIterator &begin, const RandomAccessIterator &end, Size xSize)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#64811b5cfac61b8b7f079a1e56c273f1">LexicographicalView</a> (const RandomAccessIterator &begin, const RandomAccessIterator &end, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> xSize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">attaches the view with the given dimension to a sequence <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Element access</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20b182f3ebd58c72b9d7ec207efde1bc"></a><!-- doxytag: member="QuantLib::LexicographicalView::operator[]" ref="20b182f3ebd58c72b9d7ec207efde1bc" args="(Size i)" -->
<a class="el" href="class_quant_lib_1_1step__iterator.html">y_iterator</a> </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Iterator access</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d6d0013e2b539b82adc6ee9aced4c3b"></a><!-- doxytag: member="QuantLib::LexicographicalView::xbegin" ref="5d6d0013e2b539b82adc6ee9aced4c3b" args="(Size j)" -->
<a class="el" href="class_quant_lib_1_1_lexicographical_view.html#60ae9a6c903bfa254d23a6a144ad05ae">x_iterator</a> </td><td class="memItemRight" valign="bottom"><b>xbegin</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> j)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95880e751665365e1bc72f0533ba5d43"></a><!-- doxytag: member="QuantLib::LexicographicalView::xend" ref="95880e751665365e1bc72f0533ba5d43" args="(Size j)" -->
<a class="el" href="class_quant_lib_1_1_lexicographical_view.html#60ae9a6c903bfa254d23a6a144ad05ae">x_iterator</a> </td><td class="memItemRight" valign="bottom"><b>xend</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> j)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cab55b16f1b726eb6ae7ae1b30849076"></a><!-- doxytag: member="QuantLib::LexicographicalView::rxbegin" ref="cab55b16f1b726eb6ae7ae1b30849076" args="(Size j)" -->
<a class="el" href="class_quant_lib_1_1_lexicographical_view.html#ffef015b19d72a3e5affd7f6f94c487c">reverse_x_iterator</a> </td><td class="memItemRight" valign="bottom"><b>rxbegin</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> j)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0bdc43b58a69fc779ae759e4c4b4eed"></a><!-- doxytag: member="QuantLib::LexicographicalView::rxend" ref="e0bdc43b58a69fc779ae759e4c4b4eed" args="(Size j)" -->
<a class="el" href="class_quant_lib_1_1_lexicographical_view.html#ffef015b19d72a3e5affd7f6f94c487c">reverse_x_iterator</a> </td><td class="memItemRight" valign="bottom"><b>rxend</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> j)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ada822e35e1d1e457536b934cc915c8"></a><!-- doxytag: member="QuantLib::LexicographicalView::ybegin" ref="5ada822e35e1d1e457536b934cc915c8" args="(Size i)" -->
<a class="el" href="class_quant_lib_1_1step__iterator.html">y_iterator</a> </td><td class="memItemRight" valign="bottom"><b>ybegin</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ff481378d38b12bfd7bdd4e8229f15f"></a><!-- doxytag: member="QuantLib::LexicographicalView::yend" ref="5ff481378d38b12bfd7bdd4e8229f15f" args="(Size i)" -->
<a class="el" href="class_quant_lib_1_1step__iterator.html">y_iterator</a> </td><td class="memItemRight" valign="bottom"><b>yend</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1cdbcea66a355d777a591b22f55dec4"></a><!-- doxytag: member="QuantLib::LexicographicalView::rybegin" ref="a1cdbcea66a355d777a591b22f55dec4" args="(Size i)" -->
<a class="el" href="class_quant_lib_1_1_lexicographical_view.html#9ca10f675e1e0b950cf45bb46d2ae2ad">reverse_y_iterator</a> </td><td class="memItemRight" valign="bottom"><b>rybegin</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="104ca00059e96eba5a43cb453864b8eb"></a><!-- doxytag: member="QuantLib::LexicographicalView::ryend" ref="104ca00059e96eba5a43cb453864b8eb" args="(Size i)" -->
<a class="el" href="class_quant_lib_1_1_lexicographical_view.html#9ca10f675e1e0b950cf45bb46d2ae2ad">reverse_y_iterator</a> </td><td class="memItemRight" valign="bottom"><b>ryend</b> (<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> i)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9181efab98a01d26ddb0f7d07006fdd9"></a><!-- doxytag: member="QuantLib::LexicographicalView::xSize" ref="9181efab98a01d26ddb0f7d07006fdd9" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#9181efab98a01d26ddb0f7d07006fdd9">xSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">dimension of the array along x <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8b98e629892d44bca18d9fe1e6f7b84"></a><!-- doxytag: member="QuantLib::LexicographicalView::ySize" ref="c8b98e629892d44bca18d9fe1e6f7b84" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_lexicographical_view.html#c8b98e629892d44bca18d9fe1e6f7b84">ySize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">dimension of the array along y <br></td></tr>
</table>
</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>
|
