Package org.apache.lucene.internal.hppc
Class CharObjectHashMap<VType>
- java.lang.Object
-
- org.apache.lucene.internal.hppc.CharObjectHashMap<VType>
-
- All Implemented Interfaces:
Cloneable,Iterable<CharObjectHashMap.CharObjectCursor<VType>>,Accountable
public class CharObjectHashMap<VType> extends Object implements Iterable<CharObjectHashMap.CharObjectCursor<VType>>, Accountable, Cloneable
A hash map ofchartoObject, implemented using open addressing with linear probing for collision resolution. Supports null values.Mostly forked and trimmed from com.carrotsearch.hppc.CharObjectHashMap
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 static classCharObjectHashMap.CharObjectCursor<VType>Forked from HPPC, holding int index,key and valueclassCharObjectHashMap.KeysContainerA view of the keys inside this hash map.classCharObjectHashMap.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.char[]keysThe array holding keys.protected doubleloadFactorThe load factor forkeys.protected intmaskMask for slot scans inkeys.protected intresizeAtObject[]valuesThe array holding values.-
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
-
Constructor Summary
Constructors Constructor Description CharObjectHashMap()New instance with sane defaults.CharObjectHashMap(int expectedElements)New instance with sane defaults.CharObjectHashMap(int expectedElements, double loadFactor)New instance with the provided defaults.CharObjectHashMap(CharObjectHashMap<VType> 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 protected voidallocateBuffers(int arraySize)Allocate new internal buffers.protected voidallocateThenInsertThenRehash(int slot, char pendingKey, VType 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()CharObjectHashMap<VType>clone()booleancontainsKey(char key)voidensureCapacity(int expectedElements)Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.protected booleanequalElements(CharObjectHashMap<?> other)Return true if all keys of some other container exist in this container.booleanequals(Object obj)static <VType> CharObjectHashMap<VType>from(char[] keys, VType[] values)Creates a hash map from two index-aligned arrays of key-value pairs.VTypeget(char key)VTypegetOrDefault(char key, VType defaultValue)inthashCode()protected inthashKey(char key)Returns a hash code for the given key.booleanindexExists(int index)VTypeindexGet(int index)voidindexInsert(int index, char key, VType value)intindexOf(char key)VTypeindexRemove(int index)VTypeindexReplace(int index, VType newValue)booleanisEmpty()Iterator<CharObjectHashMap.CharObjectCursor<VType>>iterator()CharObjectHashMap.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.VTypeput(char key, VType value)intputAll(Iterable<? extends CharObjectHashMap.CharObjectCursor<? extends VType>> iterable)booleanputIfAbsent(char key, VType value)Trove-inspired API method.longramBytesUsed()Return the memory usage of this object in bytes.protected voidrehash(char[] fromKeys, VType[] fromValues)Rehash from old buffers to new buffers.voidrelease()VTyperemove(char 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.CharObjectHashMap.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 char[] keys
The array holding keys.
-
values
public Object[] 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
-
CharObjectHashMap
public CharObjectHashMap()
New instance with sane defaults.
-
CharObjectHashMap
public CharObjectHashMap(int expectedElements)
New instance with sane defaults.- Parameters:
expectedElements- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
CharObjectHashMap
public CharObjectHashMap(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).
-
CharObjectHashMap
public CharObjectHashMap(CharObjectHashMap<VType> map)
Create a hash map from all key-value pairs of another map.
-
-
Method Detail
-
putAll
public int putAll(Iterable<? extends CharObjectHashMap.CharObjectCursor<? extends VType>> iterable)
-
putIfAbsent
public boolean putIfAbsent(char key, VType 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.
-
remove
public VType remove(char key)
-
get
public VType get(char key)
-
containsKey
public boolean containsKey(char key)
-
indexOf
public int indexOf(char key)
-
indexExists
public boolean indexExists(int index)
-
indexGet
public VType indexGet(int index)
-
indexInsert
public void indexInsert(int index, char key, VType value)
-
indexRemove
public VType indexRemove(int index)
-
clear
public void clear()
-
release
public void release()
-
size
public int size()
-
isEmpty
public boolean isEmpty()
-
equalElements
protected boolean equalElements(CharObjectHashMap<?> 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.
-
iterator
public Iterator<CharObjectHashMap.CharObjectCursor<VType>> iterator()
-
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
-
keys
public CharObjectHashMap.KeysContainer keys()
Returns a specialized view of the keys of this associated container.
-
values
public CharObjectHashMap.ValuesContainer values()
- Returns:
- Returns a container with all values stored in this map.
-
clone
public CharObjectHashMap<VType> clone()
-
toString
public String toString()
Convert the contents of this map to a human-friendly string.
-
from
public static <VType> CharObjectHashMap<VType> from(char[] keys, VType[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.
-
hashKey
protected int hashKey(char 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(char[] fromKeys, VType[] 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, char pendingKey, VType 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.
-
-