/
PhResultList.java
327 lines (276 loc) · 7.17 KB
/
PhResultList.java
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/*
* Copyright 2011-2016 ETH Zurich. All Rights Reserved.
* Copyright 2016-2018 Tilmann Zäschke. All Rights Reserved.
* Copyright 2019 Improbable Worlds Limited. All rights reserved.
*
* This file is part of the PH-Tree project.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ch.ethz.globis.phtree.v16;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import ch.ethz.globis.phtree.PhEntry;
import ch.ethz.globis.phtree.PhFilter;
import ch.ethz.globis.phtree.util.PhMapper;
/**
* Immutable result list.
*
* This should act as a result buffer and should be used as follows.
* API-Users simply use it as an immutable List.
*
* Internally, it should try to reuse instances as much as possible.
*
*
* @author ztilmann
*
* @param <T> Value type of the Phtree
* @param <R> Result type, such as PhEntry
*/
public abstract class PhResultList<T, R> implements List<R> {
@FunctionalInterface
interface PhEntryFactory<T> {
/**
* @return A new PhEntry instance
*/
PhEntry<T> create();
}
@FunctionalInterface
public interface PhResultMapper<T, R> {
static <T> PhResultMapper<T, PhEntry<T>> NO_MAP() {
return e -> e;
}
R map(PhEntry<T> e);
}
/**
* This method should be used to get PhEntry instances that can be offered to
* {@link #phOffer(PhEntry)}.
*
* Every temp entry must be returned via {@link #phReturnTemp(PhEntry)} or
* {@link #phOffer(PhEntry)} before the next temp entry is available.
* This ensures that a temp entry is only used in one place at a time.
*
* @return a PhEntry instance that can be used.
*/
abstract PhEntry<T> phGetTempEntry();
/**
* Return a temporary entry.
* @param entry entry
* @see PhResultList#phGetTempEntry()
*/
abstract void phReturnTemp(PhEntry<T> entry);
/**
* Offer a PhEntry to the list. The PhEntry may be stored inside the List and
* should not be used anymore.
* This method checks the offered entry and adds it only if it passes the filter
* of this List.
*
* @param e entry
*/
abstract void phOffer(PhEntry<T> e);
abstract boolean phIsPrefixValid(long[] prefix, int bitsToIgnore);
@Override
public boolean isEmpty() {
return size() == 0;
}
@Override
public boolean contains(Object o) {
throw new UnsupportedOperationException();
}
@Override
public Iterator<R> iterator() {
throw new UnsupportedOperationException();
}
@Override
public Object[] toArray() {
throw new UnsupportedOperationException();
}
@Override
public <U> U[] toArray(U[] a) {
throw new UnsupportedOperationException();
}
@Override
public boolean add(R e) {
throw new UnsupportedOperationException();
}
@Override
public boolean remove(Object o) {
throw new UnsupportedOperationException();
}
@Override
public boolean containsAll(Collection<?> c) {
for (Object o: c) {
if (!contains(o)) {
return false;
}
}
return true;
}
@Override
public boolean addAll(Collection<? extends R> c) {
throw new UnsupportedOperationException();
}
@Override
public boolean addAll(int index, Collection<? extends R> c) {
throw new UnsupportedOperationException();
}
@Override
public boolean removeAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
@Override
public boolean retainAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
@Override
public R set(int index, R element) {
throw new UnsupportedOperationException();
}
@Override
public void add(int index, R element) {
throw new UnsupportedOperationException();
}
@Override
public R remove(int index) {
throw new UnsupportedOperationException();
}
@Override
public int indexOf(Object o) {
throw new UnsupportedOperationException();
}
@Override
public int lastIndexOf(Object o) {
throw new UnsupportedOperationException();
}
@Override
public ListIterator<R> listIterator() {
throw new UnsupportedOperationException();
}
@Override
public ListIterator<R> listIterator(int index) {
throw new UnsupportedOperationException();
}
@Override
public List<R> subList(int fromIndex, int toIndex) {
throw new UnsupportedOperationException();
}
static class SimpleArrayResultList<T> extends PhResultList<T, PhEntry<T>> {
private final ArrayList<PhEntry<T>> list;
private PhEntry<T> free;
private final PhFilter filter;
public SimpleArrayResultList(int dims, PhFilter filter) {
this.list = new ArrayList<>();
this.free = new PhEntry<>(new long[dims], null);
this.filter = filter;
}
@Override
public int size() {
return list.size();
}
@Override
public void clear() {
list.clear();
}
@Override
public PhEntry<T> get(int index) {
return list.get(index);
}
@Override
PhEntry<T> phGetTempEntry() {
PhEntry<T> ret = free;
free = null;
return ret;
}
@Override
void phReturnTemp(PhEntry<T> entry) {
if (free == null) {
free = entry;
}
}
@Override
void phOffer(PhEntry<T> e) {
if (filter == null || filter.isValid(e.getKey())) {
list.add(e);
free = new PhEntry<>(new long[e.getKey().length], null);
} else {
free = e;
}
}
@Override
boolean phIsPrefixValid(long[] prefix, int bitsToIgnore) {
return filter == null || filter.isValid(bitsToIgnore, prefix);
}
}
static class MappingResultList<T, R> extends PhResultList<T, R> {
private final ArrayList<R> list;
private PhEntry<T> free;
private final PhFilter filter;
private final PhMapper<T, R> mapper;
private final PhEntryFactory<T> factory;
MappingResultList(PhFilter filter, PhMapper<T, R> mapper,
PhEntryFactory<T> factory) {
this.list = new ArrayList<>();
this.free = factory.create();
this.filter = filter;
this.mapper = mapper;
this.factory = factory;
}
@Override
public int size() {
return list.size();
}
@Override
public void clear() {
list.clear();
}
@Override
public R get(int index) {
return list.get(index);
}
@Override
PhEntry<T> phGetTempEntry() {
PhEntry<T> ret = free;
free = null;
return ret;
}
@Override
void phReturnTemp(PhEntry<T> entry) {
if (free == null) {
free = entry;
}
}
@Override
void phOffer(PhEntry<T> e) {
if (filter == null || filter.isValid(e.getKey())) {
R e2 = mapper.map(e);
list.add(e2);
//resuse e unless e is added to the list.
free = e == e2 ? factory.create() : e;
} else {
free = e;
}
}
@Override
boolean phIsPrefixValid(long[] prefix, int bitsToIgnore) {
return filter == null || filter.isValid(bitsToIgnore, prefix);
}
@Override
public Iterator<R> iterator() {
return Collections.unmodifiableList(list).iterator();
}
}
}