/
Storage.java
519 lines (441 loc) · 13.9 KB
/
Storage.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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.data.osm;
import java.util.AbstractSet;
import java.util.Collection;
import java.util.ConcurrentModificationException;
import java.util.Iterator;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import org.openstreetmap.josm.tools.Utils;
/**
* A Set-like class that allows looking up equivalent preexising instance.
* It is useful whereever one would use self-mapping construct like
* <code>Map<T,T>.put(t,t)</code>, that is, for caches, uniqueness filters or similar.
*
* The semantics of equivalency can be external to the object, using the
* {@link Hash} interface. The set also supports querying for entries using
* different key type, in case you can provide a Hash implementation
* that can resolve the equality.
*
* <h2>Examples</h2>
* <ul><li>A String cache:
* <pre>
* Storage<String> cache = new Storage(); // use default Hash
* for (String input : data) {
* String onlyOne = cache.putIfUnique(input);
* ....
* }
* </pre></li>
* <li>Identity-based set:
* <pre>
* Storage<Object> identity = new Storage(new Hash<Object,Object> {
* public int getHashCode(Object o) {
* return System.identityHashCode(o);
* }
* public boolean equals(Object o1, Object o2) {
* return o1 == o2;
* }
* });
* </pre></li>
* <li>An object with int ID and id-based lookup:
* <pre>
* class Thing { int id; }
* Storage<Thing> things = new Storage(new Hash<Thing,Thing>() {
* public int getHashCode(Thing t) {
* return t.id;
* }
* public boolean equals(Thing t1, Thing t2) {
* return t1 == t2;
* }
* });
* Map<Integer,Thing> fk = things.foreignKey(new Hash<Integer,Thing>() {
* public int getHashCode(Integer i) {
* return i.getIntValue();
* }
* public boolean equals(Integer k, Thing t) {
* return t.id == k.getIntvalue();
* }
* }
*
* things.put(new Thing(3));
* assert things.get(new Thing(3)) == fk.get(3);
* </pre></li>
* </ul>
*
* @author nenik
*/
public class Storage<T> extends AbstractSet<T> {
public static class PrimitiveIdHash implements Hash<PrimitiveId, PrimitiveId> {
@Override
public int getHashCode(PrimitiveId k) {
return (int) k.getUniqueId() ^ k.getType().hashCode();
}
@Override
public boolean equals(PrimitiveId key, PrimitiveId value) {
if (key == null || value == null) return false;
return key.getUniqueId() == value.getUniqueId() && key.getType() == value.getType();
}
}
private final Hash<? super T, ? super T> hash;
private T[] data;
private int mask;
private int size;
private volatile int modCount;
private double loadFactor = 0.6d;
private static final int DEFAULT_CAPACITY = 16;
private final boolean safeIterator;
private boolean arrayCopyNecessary;
/**
* Constructs a new {@code Storage} with default capacity (16).
*/
public Storage() {
this(Storage.<T>defaultHash(), DEFAULT_CAPACITY, false);
}
/**
* Constructs a new {@code Storage} with given capacity.
*/
public Storage(int capacity) {
this(Storage.<T>defaultHash(), capacity, false);
}
public Storage(Hash<? super T, ? super T> ha) {
this(ha, DEFAULT_CAPACITY, false);
}
public Storage(boolean safeIterator) {
this(Storage.<T>defaultHash(), DEFAULT_CAPACITY, safeIterator);
}
public Storage(int capacity, boolean safeIterator) {
this(Storage.<T>defaultHash(), capacity, safeIterator);
}
public Storage(Hash<? super T, ? super T> ha, boolean safeIterator) {
this(ha, DEFAULT_CAPACITY, safeIterator);
}
public Storage(Hash<? super T, ? super T> ha, int capacity) {
this(ha, capacity, false);
}
/**
* constructor
* @param ha hash
* @param capacity capacity
* @param safeIterator If set to false, you must not modify the Storage
* while iterating over it. If set to true, you can safely
* modify, but the read-only iteration will happen on a copy
* of the unmodified Storage.
* This is similar to CopyOnWriteArrayList.
*/
public Storage(Hash<? super T, ? super T> ha, int capacity, boolean safeIterator) {
this.hash = ha;
int cap = 1 << (int) (Math.ceil(Math.log(capacity/loadFactor) / Math.log(2)));
@SuppressWarnings("unchecked") T[] newData = (T[]) new Object[cap];
data = newData;
mask = data.length - 1;
this.safeIterator = safeIterator;
}
private void copyArray() {
if (arrayCopyNecessary) {
data = Utils.copyArray(data);
arrayCopyNecessary = false;
}
}
// --------------- Collection implementation ------------------------
@Override
public synchronized int size() {
return size;
}
@Override
public synchronized Iterator<T> iterator() {
if (safeIterator) {
arrayCopyNecessary = true;
return new SafeReadonlyIter(data);
} else
return new Iter();
}
@Override
public synchronized boolean contains(Object o) {
@SuppressWarnings("unchecked") T t = (T) o;
int bucket = getBucket(hash, t);
return bucket >= 0;
}
@Override
public synchronized boolean add(T t) {
T orig = putUnique(t);
return orig == t;
}
@Override
public synchronized boolean remove(Object o) {
@SuppressWarnings("unchecked") T t = (T) o;
T tOrig = removeElem(t);
return tOrig != null;
}
@Override
public synchronized void clear() {
copyArray();
modCount++;
size = 0;
for (int i = 0; i < data.length; i++) {
data[i] = null;
}
}
@Override
public synchronized int hashCode() {
int h = 0;
for (T t : this) {
h += hash.getHashCode(t);
}
return h;
}
// ----------------- Extended API ----------------------------
public synchronized T put(T t) {
copyArray();
modCount++;
ensureSpace();
int bucket = getBucket(hash, t);
if (bucket < 0) {
size++;
bucket = ~bucket;
assert data[bucket] == null;
}
T old = data[bucket];
data[bucket] = t;
return old;
}
public synchronized T get(T t) {
int bucket = getBucket(hash, t);
return bucket < 0 ? null : data[bucket];
}
public synchronized T putUnique(T t) {
copyArray();
modCount++;
ensureSpace();
int bucket = getBucket(hash, t);
if (bucket < 0) { // unique
size++;
assert data[~bucket] == null;
data[~bucket] = t;
return t;
}
return data[bucket];
}
public synchronized T removeElem(T t) {
copyArray();
modCount++;
int bucket = getBucket(hash, t);
return bucket < 0 ? null : doRemove(bucket);
}
public <K> Map<K, T> foreignKey(Hash<K, ? super T> h) {
return new FMap<>(h);
}
// ---------------- Implementation
/**
* Additional mixing of hash
*/
private static int rehash(int h) {
return 1103515245*h >> 2;
}
/**
* Finds a bucket for given key.
*
* @param key The key to compare
* @return the bucket equivalent to the key or -(bucket) as an empty slot
* where such an entry can be stored.
*/
private <K> int getBucket(Hash<K, ? super T> ha, K key) {
T entry;
int hcode = rehash(ha.getHashCode(key));
int bucket = hcode & mask;
while ((entry = data[bucket]) != null) {
if (ha.equals(key, entry))
return bucket;
bucket = (bucket+1) & mask;
}
return ~bucket;
}
private T doRemove(int slot) {
T t = data[slot];
assert t != null;
fillTheHole(slot); // fill the hole (or null it)
size--;
return t;
}
private void fillTheHole(int hole) {
int bucket = (hole+1) & mask;
T entry;
while ((entry = data[bucket]) != null) {
int right = rehash(hash.getHashCode(entry)) & mask;
// if the entry should be in <hole+1,bucket-1> (circular-wise)
// we can't move it. The move can be proved safe otherwise,
// because the entry safely belongs to <previous_null+1,hole>
if ((bucket < right && (right <= hole || hole <= bucket)) ||
(right <= hole && hole <= bucket)) {
data[hole] = data[bucket];
hole = bucket;
}
bucket = (bucket+1) & mask;
}
// no entry belongs here, just null out the slot
data[hole] = null;
}
private void ensureSpace() {
if (size > data.length*loadFactor) { // rehash
@SuppressWarnings("unchecked") T[] big = (T[]) new Object[data.length * 2];
int nMask = big.length - 1;
for (T o : data) {
if (o == null) {
continue;
}
int bucket = rehash(hash.getHashCode(o)) & nMask;
while (big[bucket] != null) {
bucket = (bucket+1) & nMask;
}
big[bucket] = o;
}
data = big;
mask = nMask;
}
}
// -------------- factories --------------------
/**
* A factory for default hash implementation.
* @return a hash implementation that just delegates to object's own
* hashCode and equals.
*/
public static <O> Hash<O, O> defaultHash() {
return new Hash<O, O>() {
@Override
public int getHashCode(O t) {
return t.hashCode();
}
@Override
public boolean equals(O t1, O t2) {
return t1.equals(t2);
}
};
}
private final class FMap<K> implements Map<K, T> {
private Hash<K, ? super T> fHash;
private FMap(Hash<K, ? super T> h) {
fHash = h;
}
@Override
public int size() {
return Storage.this.size();
}
@Override
public boolean isEmpty() {
return Storage.this.isEmpty();
}
@Override
public boolean containsKey(Object o) {
@SuppressWarnings("unchecked") K key = (K) o;
int bucket = getBucket(fHash, key);
return bucket >= 0;
}
@Override
public boolean containsValue(Object value) {
return Storage.this.contains(value);
}
@Override
public T get(Object o) {
@SuppressWarnings("unchecked") K key = (K) o;
int bucket = getBucket(fHash, key);
return bucket < 0 ? null : data[bucket];
}
@Override
public T put(K key, T value) {
if (!fHash.equals(key, value)) throw new IllegalArgumentException("inconsistent key");
return Storage.this.put(value);
}
@Override
public T remove(Object o) {
modCount++;
@SuppressWarnings("unchecked") K key = (K) o;
int bucket = getBucket(fHash, key);
return bucket < 0 ? null : doRemove(bucket);
}
@Override
public void putAll(Map<? extends K, ? extends T> m) {
if (m instanceof Storage.FMap) {
Storage.this.addAll(m.values());
} else {
for (Map.Entry<? extends K, ? extends T> e : m.entrySet()) {
put(e.getKey(), e.getValue());
}
}
}
@Override
public void clear() {
Storage.this.clear();
}
@Override
public Set<K> keySet() {
throw new UnsupportedOperationException();
}
@Override
public Collection<T> values() {
return Storage.this;
}
@Override
public Set<Entry<K, T>> entrySet() {
throw new UnsupportedOperationException();
}
}
private final class SafeReadonlyIter implements Iterator<T> {
private final T[] data;
private int slot;
SafeReadonlyIter(T[] data) {
this.data = data;
}
@Override
public boolean hasNext() {
align();
return slot < data.length;
}
@Override
public T next() {
if (!hasNext()) throw new NoSuchElementException();
return data[slot++];
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
private void align() {
while (slot < data.length && data[slot] == null) {
slot++;
}
}
}
private final class Iter implements Iterator<T> {
private final int mods;
private int slot;
private int removeSlot = -1;
Iter() {
mods = modCount;
}
@Override
public boolean hasNext() {
align();
return slot < data.length;
}
@Override
public T next() {
if (!hasNext()) throw new NoSuchElementException();
removeSlot = slot;
return data[slot++];
}
@Override
public void remove() {
if (removeSlot == -1) throw new IllegalStateException();
doRemove(removeSlot);
slot = removeSlot; // some entry might have been relocated here
removeSlot = -1;
}
private void align() {
if (mods != modCount)
throw new ConcurrentModificationException();
while (slot < data.length && data[slot] == null) {
slot++;
}
}
}
}