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
|
//# ExprNodeSetOpt.h: Classes representing an optimized set in table select expression
//# Copyright (C) 2022
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef TABLES_EXPRNODESETOPT_H
#define TABLES_EXPRNODESETOPT_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/TaQL/ExprNodeRep.h>
#include <unordered_map>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// Forward Declarations
class TableExprNodeSet;
// <summary>
// Abstract base class for optimized set representations
// </summary>
// <use visibility=local>
// <reviewed reviewer="Mordante" date="2022/11/08" tests="tExprNodeSetOpt.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> TableExprNodeSet
// </prerequisite>
// <synopsis>
// This class is the abstract base class for the optimized representation of
// constant value or interval sets used by the IN operator or join operator.
//
// The <src>find</src> function can operate on integer, double and string values.
// Note that datetimes are handled as doubles. It returns the index of the
// value or interval matching the value searched for.
// </synopsis>
class TableExprNodeSetOptBase : public TableExprNodeRep
{
public:
explicit TableExprNodeSetOptBase (const TableExprNodeRep& orig);
// Does the set contain the given value?
// They call the <src>find</src> function.
// <group>
Bool contains (const TableExprId& id, Int64 value) override;
Bool contains (const TableExprId& id, Double value) override;
Bool contains (const TableExprId& id, String value) override;
// </group>
// Tell for each array value if the set contains that value.
// It calls the scalar <src>contains</src> function for each value.
// <group>
MArray<Bool> contains (const TableExprId& id,
const MArray<Int64>& value) override;
MArray<Bool> contains (const TableExprId& id,
const MArray<Double>& value) override;
MArray<Bool> contains (const TableExprId& id,
const MArray<String>& value) override;
// </group>
// Tell which key matches a value. -1 = no match.
// The default implementations throw a 'not implemented' exception.
//# The String version is passed by value to use the same mechanism
//# as used for the other types to make templates possible.
// <group>
virtual Int64 find (Int64 value) const;
virtual Int64 find (Double value) const;
virtual Int64 find (String value) const;
// </group>
private:
// Explicitly hide base function to prevent warning
using TableExprNodeRep::contains;
};
// <summary>
// An optimized representation of a discrete selection set.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Mordante" date="2022/11/08" tests="tExprNodeSetOpt.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> TableExprNodeSet
// </prerequisite>
// <synopsis>
// This templated class is an optimized representation of an constant
// integer or string array set used by the IN operator.
// If applicable, TableExprLogicNode instantiates an object of this class.
// <br>The representation is a std::unordered_map containing the array values
// and the index in the array.
// <br>Note that a std::unordered_map is used instead of std::map because its
// hashing mechanism makes it faster.
// </synopsis>
template <typename T>
class TableExprNodeSetOptUSet: public TableExprNodeSetOptBase
{
public:
// Construct an empty set.
TableExprNodeSetOptUSet (const TableExprNodeRep& orig, const Array<T>&);
// Show the node.
void show (ostream& os, uInt indent) const override;
// Where does a value occur in the set? -1 is no match.
Int64 find (T value) const override;
private:
std::unordered_map<T,Int64> itsMap;
// Explicitly hide base function to prevent warning
using TableExprNodeSetOptBase::find;
};
// <summary>
// An optimized representation of a selection set with continuous intervals.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Mordante" date="2022/11/08" tests="tExprNodeSetOpt.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> TableExprNodeSet
// </prerequisite>
// <synopsis>
// This class is the base class for the optimized representations of a
// constant selection set with continuous intervals.
// It holds the start and end values of the intervals.
// </synopsis>
template<typename T>
class TableExprNodeSetOptContSetBase: public TableExprNodeSetOptBase
{
public:
// Construct from the original set and the start and end values of the
// intervals. The vectors must have the same length.
explicit TableExprNodeSetOptContSetBase (const TableExprNodeSet& orig,
const std::vector<T>& starts,
const std::vector<T>& ends);
// Get the size (nr of intervals).
size_t size() const
{ return itsStarts.size(); }
// Show the node.
void show (ostream& os, uInt indent) const override;
// Transform a set into an optimized one by ordering the intervals
// and optionally combining adjacent intervals.
// If not possible, an empty TENShPtr is returned.
static TENShPtr transform (const TableExprNodeSet& set,
Bool combine=True);
// Create the appropriate optimized OptContSet object.
// Note that leftC and rightC do not need to have the same length as start/end.
// If it is known that all intervals have the same leftC/rightC,
// a single value suffices.
static TENShPtr createOptSet (const TableExprNodeSet& set,
const std::vector<T>& start,
const std::vector<T>& end,
const std::vector<Bool>& leftC,
const std::vector<Bool>& rightC);
protected:
std::vector<T> itsStarts;
std::vector<T> itsEnds;
};
// <summary>
// An optimized representation of a selection set with continuous intervals.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Mordante" date="2022/11/08" tests="tExprNodeSetOpt.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> TableExprNodeSet
// </prerequisite>
// <synopsis>
// This class is an optimized representation of a constant selection set
// with continuous intervals using a mix of open and closed start and end.
// If applicable, TableExprLogicNode instantiates an object of this class.
// <br>The representation has std::vector objects containing the start
// and end values. A lookup using std::upper_bound on the end values is done
// to determine if a value is contained in one of the intervals.
// <br>This templated class is instantiated for Double and String.
// </synopsis>
template <typename T>
class TableExprNodeSetOptContSetMixOC: public TableExprNodeSetOptContSetBase<T>
{
public:
TableExprNodeSetOptContSetMixOC (const TableExprNodeSet& orig,
const std::vector<T>& starts,
const std::vector<T>& ends,
const std::vector<Bool>& leftC,
const std::vector<Bool>& rightC);
// Show the node.
void show (ostream& os, uInt indent) const override;
// Tell which interval contains a value. -1 = no match.
Int64 find (T value) const override;
protected:
std::vector<Bool> itsLeftC;
std::vector<Bool> itsRightC;
private:
// Explicitly hide base function to prevent warning
using TableExprNodeSetOptBase::find;
};
// <summary>
// An optimized representation of a selection set with similar intervals.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Mordante" date="2022/11/08" tests="tExprNodeSetOpt.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> TableExprNodeSetOptContSet
// </prerequisite>
// <synopsis>
// This class is a further optimized version of TableExprNodeSetOptContSet
// for continuous intervals all using the same open/closed interval types.
// It reduces the number of comparisons required.
// The left and right comparison functors tell if an interval side is
// open (uses std::less) or closed (uses std::less_equal).
// </synopsis>
template <typename T, typename LeftComp, typename RightComp>
class TableExprNodeSetOptContSet: public TableExprNodeSetOptContSetBase<T>
{
public:
TableExprNodeSetOptContSet (const TableExprNodeSet& orig,
const std::vector<T>& starts,
const std::vector<T>& ends,
LeftComp leftCmp, RightComp rightCmp,
const String& cmpType);
// Show the node.
void show (ostream& os, uInt indent) const override;
// Tell which interval contains a value. -1 = no match.
Int64 find (T value) const override;
private:
LeftComp itsLeftCmp;
RightComp itsRightCmp;
String itsCmpType;
// Explicitly hide base function to prevent warning
using TableExprNodeSetOptBase::find;
};
} //# NAMESPACE CASACORE - END
#endif
|
