@Generated(date="2015-05-05T11:00:02+0200", value="KTypeVTypeHashMap.java") public class ObjectIntHashMap<KType> extends java.lang.Object implements ObjectIntMap<KType>, Preallocable, java.lang.Cloneable
Object
to int
, implemented using open
addressing with linear probing for collision resolution.
Note: read about important differences between hash and scatter sets.
ObjectIntScatterMap
,
HPPC interfaces diagramModifier and Type | Class and Description |
---|---|
class |
ObjectIntHashMap.KeysContainer
A view of the keys inside this hash map.
|
Modifier and Type | Field and Description |
---|---|
protected int |
assigned
The number of stored keys (assigned key slots), excluding the special
"empty" key, if any (use
size() instead). |
protected boolean |
hasEmptyKey
Special treatment for the "empty slot" key marker.
|
protected int |
keyMixer
We perturb hash values with a container-unique
seed to avoid problems with nearly-sorted-by-hash
values on iterations.
|
java.lang.Object[] |
keys
The array holding keys.
|
protected double |
loadFactor
The load factor for
keys . |
protected int |
mask
Mask for slot scans in
keys . |
protected HashOrderMixingStrategy |
orderMixer
Per-instance hash order mixing strategy.
|
protected int |
resizeAt
|
int[] |
values
The array holding values.
|
Constructor and Description |
---|
ObjectIntHashMap()
New instance with sane defaults.
|
ObjectIntHashMap(int expectedElements)
New instance with sane defaults.
|
ObjectIntHashMap(int expectedElements,
double loadFactor)
New instance with sane defaults.
|
ObjectIntHashMap(int expectedElements,
double loadFactor,
HashOrderMixingStrategy orderMixer)
New instance with the provided defaults.
|
ObjectIntHashMap(ObjectIntAssociativeContainer<? extends KType> container)
Create a hash map from all key-value pairs of another container.
|
Modifier and Type | Method and Description |
---|---|
int |
addTo(KType key,
int incrementValue)
Adds
incrementValue to any existing value for the given key
or inserts incrementValue if key did not previously exist. |
protected void |
allocateBuffers(int arraySize)
Allocate new internal buffers.
|
protected void |
allocateThenInsertThenRehash(int slot,
KType 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.
|
void |
clear()
Clear all keys and values in the container.
|
ObjectIntHashMap<KType> |
clone() |
boolean |
containsKey(KType key)
Returns
true if this container has an association to a value
for the given key. |
void |
ensureCapacity(int expectedElements)
Ensure this container can hold at least the
given number of keys (entries) without resizing its buffers.
|
protected boolean |
equalElements(ObjectIntHashMap<?> other)
Return true if all keys of some other container exist in this container.
|
boolean |
equals(java.lang.Object obj)
Compares the specified object with this set for equality.
|
protected boolean |
equals(java.lang.Object v1,
java.lang.Object v2) |
<T extends ObjectIntPredicate<? super KType>> |
forEach(T predicate)
Applies a given predicate to all keys-value pairs in this container.
|
<T extends ObjectIntProcedure<? super KType>> |
forEach(T procedure)
Applies a given procedure to all keys-value pairs in this container.
|
static <KType> ObjectIntHashMap<KType> |
from(KType[] keys,
int[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.
|
int |
get(KType key) |
int |
getOrDefault(KType key,
int defaultValue) |
int |
hashCode() |
protected int |
hashKey(KType key)
Returns a hash code for the given key.
|
boolean |
indexExists(int index) |
int |
indexGet(int index)
Returns the value associated with an existing key.
|
void |
indexInsert(int index,
KType key,
int value)
Inserts a key-value pair for a key that is not present in the map.
|
int |
indexOf(KType key)
Returns a logical "index" of a given key that can be used to speed up
follow-up value setters or getters in certain scenarios (conditional
logic).
|
int |
indexReplace(int index,
int newValue)
Replaces the value associated with an existing key and returns any previous
value stored for that key.
|
boolean |
isEmpty() |
java.util.Iterator<ObjectIntCursor<KType>> |
iterator()
Returns a cursor over the entries (key-value pairs) in this map.
|
ObjectIntHashMap.KeysContainer |
keys()
Returns a specialized view of the keys of this associated container.
|
int |
put(KType key,
int value)
Place a given key and value in the container.
|
int |
putAll(java.lang.Iterable<? extends ObjectIntCursor<? extends KType>> iterable)
Puts all key/value pairs from a given iterable into this map.
|
int |
putAll(ObjectIntAssociativeContainer<? extends KType> container)
Puts all keys from another container to this map, replacing the values of
existing keys, if such keys are present.
|
boolean |
putIfAbsent(KType key,
int value)
Trove-inspired API method.
|
int |
putOrAdd(KType key,
int putValue,
int incrementValue)
If
key exists, putValue is inserted into the map,
otherwise any existing value is incremented by additionValue . |
protected void |
rehash(KType[] fromKeys,
int[] fromValues)
Rehash from old buffers to new buffers.
|
void |
release()
Removes all elements from the collection and additionally releases any
internal buffers.
|
int |
remove(KType key)
Remove all values at the given key.
|
int |
removeAll(ObjectContainer<? super KType> other)
Removes all keys (and associated values) present in a given container.
|
int |
removeAll(ObjectIntPredicate<? super KType> predicate)
Removes all keys (and associated values) for which the predicate returns
true . |
int |
removeAll(ObjectPredicate<? super KType> predicate)
Removes all keys (and associated values) for which the predicate returns
true . |
protected void |
shiftConflictingKeys(int gapSlot)
Shift all the slot-conflicting keys and values allocated to
(and including)
slot . |
int |
size() |
java.lang.String |
toString()
Convert the contents of this map to a human-friendly string.
|
IntCollection |
values()
Returns a container view of all values present in this container.
|
protected double |
verifyLoadFactor(double loadFactor)
Validate load factor range and return it.
|
public java.lang.Object[] keys
public int[] values
protected int keyMixer
hashKey(KType)
,
"http://issues.carrot2.org/browse/HPPC-80",
"http://issues.carrot2.org/browse/HPPC-103"protected int assigned
size()
instead).size()
protected int mask
keys
.protected int resizeAt
protected boolean hasEmptyKey
protected double loadFactor
keys
.protected HashOrderMixingStrategy orderMixer
keyMixer
public ObjectIntHashMap()
public ObjectIntHashMap(int expectedElements)
expectedElements
- The expected number of elements guaranteed not to cause buffer
expansion (inclusive).public ObjectIntHashMap(int expectedElements, double loadFactor)
expectedElements
- The expected number of elements guaranteed not to cause buffer
expansion (inclusive).loadFactor
- The load factor for internal buffers. Insane load factors (zero, full capacity)
are rejected by verifyLoadFactor(double)
.public ObjectIntHashMap(int expectedElements, double loadFactor, HashOrderMixingStrategy orderMixer)
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 by verifyLoadFactor(double)
.orderMixer
- Hash key order mixing strategy. See HashOrderMixing
for predefined
implementations. Use constant mixers only if you understand the potential
consequences.public ObjectIntHashMap(ObjectIntAssociativeContainer<? extends KType> container)
public int put(KType key, int value)
put
in interface ObjectIntMap<KType>
public int putAll(ObjectIntAssociativeContainer<? extends KType> container)
putAll
in interface ObjectIntMap<KType>
public int putAll(java.lang.Iterable<? extends ObjectIntCursor<? extends KType>> iterable)
putAll
in interface ObjectIntMap<KType>
public boolean putIfAbsent(KType key, int value)
if (!map.containsKey(key)) map.put(value);
key
- The key of the value to check.value
- The value to put if key
does not exist.true
if key
did not exist and value
was placed in the map.public int putOrAdd(KType key, int putValue, int incrementValue)
key
exists, putValue
is inserted into the map,
otherwise any existing value is incremented by additionValue
.putOrAdd
in interface ObjectIntMap<KType>
key
- The key of the value to adjust.putValue
- The value to put if key
does not exist.incrementValue
- The value to add to the existing value if key
exists.key
(after
changes).public int addTo(KType key, int incrementValue)
incrementValue
to any existing value for the given key
or inserts incrementValue
if key
did not previously exist.addTo
in interface ObjectIntMap<KType>
key
- The key of the value to adjust.incrementValue
- The value to put or add to the existing value if key
exists.key
(after changes).public int remove(KType key)
remove
in interface ObjectIntMap<KType>
public int removeAll(ObjectContainer<? super KType> other)
keys().removeAll(container)but with no additional overhead.
removeAll
in interface ObjectIntAssociativeContainer<KType>
public int removeAll(ObjectIntPredicate<? super KType> predicate)
true
.removeAll
in interface ObjectIntAssociativeContainer<KType>
public int removeAll(ObjectPredicate<? super KType> predicate)
true
.removeAll
in interface ObjectIntAssociativeContainer<KType>
public int get(KType key)
get
in interface ObjectIntMap<KType>
public int getOrDefault(KType key, int defaultValue)
getOrDefault
in interface ObjectIntMap<KType>
public boolean containsKey(KType key)
true
if this container has an association to a value
for the given key.containsKey
in interface ObjectIntAssociativeContainer<KType>
public int indexOf(KType key)
indexOf
in interface ObjectIntMap<KType>
key
- The key to locate in the map.ObjectIntMap.indexExists(int)
,
ObjectIntMap.indexGet(int)
,
ObjectIntMap.indexInsert(int, KType, int)
,
ObjectIntMap.indexReplace(int, int)
public boolean indexExists(int index)
indexExists
in interface ObjectIntMap<KType>
index
- The index of a given key, as returned from ObjectIntMap.indexOf(KType)
.true
if the index corresponds to an existing
key or false otherwise. This is equivalent to checking whether the
index is a positive value (existing keys) or a negative value
(non-existing keys).ObjectIntMap.indexOf(KType)
public int indexGet(int index)
indexGet
in interface ObjectIntMap<KType>
index
- The index of an existing key.ObjectIntMap.indexOf(KType)
public int indexReplace(int index, int newValue)
indexReplace
in interface ObjectIntMap<KType>
index
- The index of an existing key.ObjectIntMap.indexOf(KType)
public void indexInsert(int index, KType key, int value)
indexInsert
in interface ObjectIntMap<KType>
index
- The index of a previously non-existing key, as returned from
ObjectIntMap.indexOf(KType)
.ObjectIntMap.indexOf(KType)
public void clear()
clear
in interface ObjectIntMap<KType>
ObjectIntMap.release()
public void release()
ObjectIntMap.clear()
should be a better alternative since it'll avoid
reallocation.release
in interface ObjectIntMap<KType>
ObjectIntMap.clear()
public int size()
size
in interface ObjectIntAssociativeContainer<KType>
public boolean isEmpty()
isEmpty
in interface ObjectIntAssociativeContainer<KType>
true
if this hash map contains no assigned
keys.public int hashCode()
hashCode
in interface ObjectIntMap<KType>
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
ObjectIntMap
and both objects contains exactly the same key-value
pairs.equals
in interface ObjectIntMap<KType>
equals
in class java.lang.Object
protected boolean equalElements(ObjectIntHashMap<?> other)
equals(Object, Object)
method.public void ensureCapacity(int expectedElements)
ensureCapacity
in interface Preallocable
expectedElements
- The total number of keys, inclusive.public java.util.Iterator<ObjectIntCursor<KType>> iterator()
Iterator.next()
. To read the current
key and value use the cursor's public fields. An example is shown below.
for (IntShortCursor c : intShortMap) { System.out.println("index=" + c.index + " key=" + c.key + " value=" + c.value); }
The index
field inside the cursor gives the internal index
inside the container's implementation. The interpretation of this index
depends on to the container.
iterator
in interface ObjectIntAssociativeContainer<KType>
iterator
in interface java.lang.Iterable<ObjectIntCursor<KType>>
public <T extends ObjectIntProcedure<? super KType>> T forEach(T procedure)
ObjectIntProcedure
. This
lets the caller to call methods of the argument by chaining the call (even
if the argument is an anonymous type) to retrieve computed values, for
example.forEach
in interface ObjectIntAssociativeContainer<KType>
public <T extends ObjectIntPredicate<? super KType>> T forEach(T predicate)
ObjectIntPredicate
. This
lets the caller to call methods of the argument by chaining the call (even
if the argument is an anonymous type) to retrieve computed values, for
example.
The iteration is continued as long as the predicate returns
true
.forEach
in interface ObjectIntAssociativeContainer<KType>
public ObjectIntHashMap.KeysContainer keys()
ObjectLookupContainer
.keys
in interface ObjectIntAssociativeContainer<KType>
public IntCollection values()
ObjectIntAssociativeContainer
values
in interface ObjectIntAssociativeContainer<KType>
public ObjectIntHashMap<KType> clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static <KType> ObjectIntHashMap<KType> from(KType[] keys, int[] values)
protected int hashKey(KType key)
The default implementation mixes the hash of the key with keyMixer
to differentiate hash order of keys between hash containers. Helps
alleviate problems resulting from linear conflict resolution in open
addressing.
The output from this function should evenly distribute keys across the entire integer range.
protected double verifyLoadFactor(double loadFactor)
protected void rehash(KType[] fromKeys, int[] fromValues)
protected void allocateBuffers(int arraySize)
protected void allocateThenInsertThenRehash(int slot, KType pendingKey, int pendingValue)
protected void shiftConflictingKeys(int gapSlot)
slot
.protected boolean equals(java.lang.Object v1, java.lang.Object v2)
Copyright © 2015 Carrot Search s.c.. All Rights Reserved.