Package org.apache.lucene.internal.hppc
Class LongIntHashMap
- java.lang.Object
-
- org.apache.lucene.internal.hppc.LongIntHashMap
-
- All Implemented Interfaces:
Cloneable,Iterable<LongIntHashMap.LongIntCursor>,Accountable
public class LongIntHashMap extends Object implements Iterable<LongIntHashMap.LongIntCursor>, Accountable, Cloneable
A hash map oflongtoint, implemented using open addressing with linear probing for collision resolution.Mostly forked and trimmed from com.carrotsearch.hppc.LongIntHashMap
github: https://github.com/carrotsearch/hppc release 0.10.0
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classLongIntHashMap.KeysContainerA view of the keys inside this hash map.static classLongIntHashMap.LongIntCursorForked from HPPC, holding int index,key and valueclassLongIntHashMap.ValuesContainerA view over the set of values of this map.
-
Field Summary
Fields Modifier and Type Field Description protected intassignedThe number of stored keys (assigned key slots), excluding the special "empty" key, if any (usesize()instead).protected booleanhasEmptyKeySpecial treatment for the "empty slot" key marker.protected intiterationSeedSeed used to ensure the hash iteration order is different from an iteration to another.long[]keysThe array holding keys.protected doubleloadFactorThe load factor forkeys.protected intmaskMask for slot scans inkeys.protected intresizeAtint[]valuesThe array holding values.-
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
-
Constructor Summary
Constructors Constructor Description LongIntHashMap()New instance with sane defaults.LongIntHashMap(int expectedElements)New instance with sane defaults.LongIntHashMap(int expectedElements, double loadFactor)New instance with the provided defaults.LongIntHashMap(LongIntHashMap map)Create a hash map from all key-value pairs of another map.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intaddTo(long key, int incrementValue)AddsincrementValueto any existing value for the givenkeyor insertsincrementValueifkeydid not previously exist.protected voidallocateBuffers(int arraySize)Allocate new internal buffers.protected voidallocateThenInsertThenRehash(int slot, long pendingKey, int pendingValue)This method is invoked when there is a new key/ value pair to be inserted into the buffers but there is not enough empty slots to do so.voidclear()LongIntHashMapclone()booleancontainsKey(long key)voidensureCapacity(int expectedElements)Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.protected booleanequalElements(LongIntHashMap other)Return true if all keys of some other container exist in this container.booleanequals(Object obj)static LongIntHashMapfrom(long[] keys, int[] values)Creates a hash map from two index-aligned arrays of key-value pairs.intget(long key)intgetOrDefault(long key, int defaultValue)inthashCode()protected inthashKey(long key)Returns a hash code for the given key.booleanindexExists(int index)intindexGet(int index)voidindexInsert(int index, long key, int value)intindexOf(long key)intindexRemove(int index)intindexReplace(int index, int newValue)booleanisEmpty()Iterator<LongIntHashMap.LongIntCursor>iterator()LongIntHashMap.KeysContainerkeys()Returns a specialized view of the keys of this associated container.protected intnextIterationSeed()Provides the next iteration seed used to build the iteration starting slot and offset increment.intput(long key, int value)intputAll(Iterable<? extends LongIntHashMap.LongIntCursor> iterable)booleanputIfAbsent(long key, int value)Trove-inspired API method.intputOrAdd(long key, int putValue, int incrementValue)Ifkeyexists,putValueis inserted into the map, otherwise any existing value is incremented byadditionValue.longramBytesUsed()Return the memory usage of this object in bytes.protected voidrehash(long[] fromKeys, int[] fromValues)Rehash from old buffers to new buffers.voidrelease()intremove(long key)protected voidshiftConflictingKeys(int gapSlot)Shift all the slot-conflicting keys and values allocated to (and including)slot.intsize()StringtoString()Convert the contents of this map to a human-friendly string.LongIntHashMap.ValuesContainervalues()protected doubleverifyLoadFactor(double loadFactor)Validate load factor range and return it.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Field Detail
-
keys
public long[] keys
The array holding keys.
-
values
public int[] values
The array holding values.
-
assigned
protected int assigned
The number of stored keys (assigned key slots), excluding the special "empty" key, if any (usesize()instead).- See Also:
size()
-
mask
protected int mask
Mask for slot scans inkeys.
-
resizeAt
protected int resizeAt
-
hasEmptyKey
protected boolean hasEmptyKey
Special treatment for the "empty slot" key marker.
-
loadFactor
protected double loadFactor
The load factor forkeys.
-
iterationSeed
protected int iterationSeed
Seed used to ensure the hash iteration order is different from an iteration to another.
-
-
Constructor Detail
-
LongIntHashMap
public LongIntHashMap()
New instance with sane defaults.
-
LongIntHashMap
public LongIntHashMap(int expectedElements)
New instance with sane defaults.- Parameters:
expectedElements- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
LongIntHashMap
public LongIntHashMap(int expectedElements, double loadFactor)New instance with the provided defaults.- Parameters:
expectedElements- The expected number of elements guaranteed not to cause a rehash (inclusive).loadFactor- The load factor for internal buffers. Insane load factors (zero, full capacity) are rejected byverifyLoadFactor(double).
-
LongIntHashMap
public LongIntHashMap(LongIntHashMap map)
Create a hash map from all key-value pairs of another map.
-
-
Method Detail
-
put
public int put(long key, int value)
-
putAll
public int putAll(Iterable<? extends LongIntHashMap.LongIntCursor> iterable)
-
putIfAbsent
public boolean putIfAbsent(long key, int value)Trove-inspired API method. An equivalent of the following code:if (!map.containsKey(key)) map.put(value);
- Parameters:
key- The key of the value to check.value- The value to put ifkeydoes not exist.- Returns:
trueifkeydid not exist andvaluewas placed in the map.
-
putOrAdd
public int putOrAdd(long key, int putValue, int incrementValue)Ifkeyexists,putValueis inserted into the map, otherwise any existing value is incremented byadditionValue.- Parameters:
key- The key of the value to adjust.putValue- The value to put ifkeydoes not exist.incrementValue- The value to add to the existing value ifkeyexists.- Returns:
- Returns the current value associated with
key(after changes).
-
addTo
public int addTo(long key, int incrementValue)AddsincrementValueto any existing value for the givenkeyor insertsincrementValueifkeydid not previously exist.- Parameters:
key- The key of the value to adjust.incrementValue- The value to put or add to the existing value ifkeyexists.- Returns:
- Returns the current value associated with
key(after changes).
-
remove
public int remove(long key)
-
get
public int get(long key)
-
getOrDefault
public int getOrDefault(long key, int defaultValue)
-
containsKey
public boolean containsKey(long key)
-
indexOf
public int indexOf(long key)
-
indexExists
public boolean indexExists(int index)
-
indexGet
public int indexGet(int index)
-
indexReplace
public int indexReplace(int index, int newValue)
-
indexInsert
public void indexInsert(int index, long key, int value)
-
indexRemove
public int indexRemove(int index)
-
clear
public void clear()
-
release
public void release()
-
size
public int size()
-
isEmpty
public boolean isEmpty()
-
equalElements
protected boolean equalElements(LongIntHashMap other)
Return true if all keys of some other container exist in this container.
-
ensureCapacity
public void ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.- Parameters:
expectedElements- The total number of keys, inclusive.
-
nextIterationSeed
protected int nextIterationSeed()
Provides the next iteration seed used to build the iteration starting slot and offset increment. This method does not need to be synchronized, what matters is that each thread gets a sequence of varying seeds.
-
ramBytesUsed
public long ramBytesUsed()
Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal.- Specified by:
ramBytesUsedin interfaceAccountable
-
iterator
public Iterator<LongIntHashMap.LongIntCursor> iterator()
- Specified by:
iteratorin interfaceIterable<LongIntHashMap.LongIntCursor>
-
keys
public LongIntHashMap.KeysContainer keys()
Returns a specialized view of the keys of this associated container.
-
values
public LongIntHashMap.ValuesContainer values()
- Returns:
- Returns a container with all values stored in this map.
-
clone
public LongIntHashMap clone()
-
toString
public String toString()
Convert the contents of this map to a human-friendly string.
-
from
public static LongIntHashMap from(long[] keys, int[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.
-
hashKey
protected int hashKey(long key)
Returns a hash code for the given key.The output from this function should evenly distribute keys across the entire integer range.
-
verifyLoadFactor
protected double verifyLoadFactor(double loadFactor)
Validate load factor range and return it. Override and suppress if you need insane load factors.
-
rehash
protected void rehash(long[] fromKeys, int[] fromValues)Rehash from old buffers to new buffers.
-
allocateBuffers
protected void allocateBuffers(int arraySize)
Allocate new internal buffers. This method attempts to allocate and assign internal buffers atomically (either allocations succeed or not).
-
allocateThenInsertThenRehash
protected void allocateThenInsertThenRehash(int slot, long pendingKey, int pendingValue)This method is invoked when there is a new key/ value pair to be inserted into the buffers but there is not enough empty slots to do so.New buffers are allocated. If this succeeds, we know we can proceed with rehashing so we assign the pending element to the previous buffer (possibly violating the invariant of having at least one empty slot) and rehash all keys, substituting new buffers at the end.
-
shiftConflictingKeys
protected void shiftConflictingKeys(int gapSlot)
Shift all the slot-conflicting keys and values allocated to (and including)slot.
-
-