@Generated(date="2015-05-05T11:00:02+0200", value="KTypeVTypeHashMap.java") public class IntShortHashMap extends java.lang.Object implements IntShortMap, Preallocable, java.lang.Cloneable
int
to short
, implemented using open
addressing with linear probing for collision resolution.
Note: read about important differences between hash and scatter sets.
IntShortScatterMap
,
HPPC interfaces diagramModifier and Type | Class and Description |
---|---|
class |
IntShortHashMap.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.
|
int[] |
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
|
short[] |
values
The array holding values.
|
Constructor and Description |
---|
IntShortHashMap()
New instance with sane defaults.
|
IntShortHashMap(int expectedElements)
New instance with sane defaults.
|
IntShortHashMap(int expectedElements,
double loadFactor)
New instance with sane defaults.
|
IntShortHashMap(int expectedElements,
double loadFactor,
HashOrderMixingStrategy orderMixer)
New instance with the provided defaults.
|
IntShortHashMap(IntShortAssociativeContainer container)
Create a hash map from all key-value pairs of another container.
|
Modifier and Type | Method and Description |
---|---|
short |
addTo(int key,
short 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,
int pendingKey,
short 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.
|
IntShortHashMap |
clone() |
boolean |
containsKey(int 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(IntShortHashMap 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.
|
<T extends IntShortPredicate> |
forEach(T predicate)
Applies a given predicate to all keys-value pairs in this container.
|
<T extends IntShortProcedure> |
forEach(T procedure)
Applies a given procedure to all keys-value pairs in this container.
|
static IntShortHashMap |
from(int[] keys,
short[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.
|
short |
get(int key) |
short |
getOrDefault(int key,
short defaultValue) |
int |
hashCode() |
protected int |
hashKey(int key)
Returns a hash code for the given key.
|
boolean |
indexExists(int index) |
short |
indexGet(int index)
Returns the value associated with an existing key.
|
void |
indexInsert(int index,
int key,
short value)
Inserts a key-value pair for a key that is not present in the map.
|
int |
indexOf(int 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).
|
short |
indexReplace(int index,
short newValue)
Replaces the value associated with an existing key and returns any previous
value stored for that key.
|
boolean |
isEmpty() |
java.util.Iterator<IntShortCursor> |
iterator()
Returns a cursor over the entries (key-value pairs) in this map.
|
IntShortHashMap.KeysContainer |
keys()
Returns a specialized view of the keys of this associated container.
|
short |
put(int key,
short value)
Place a given key and value in the container.
|
int |
putAll(IntShortAssociativeContainer container)
Puts all keys from another container to this map, replacing the values of
existing keys, if such keys are present.
|
int |
putAll(java.lang.Iterable<? extends IntShortCursor> iterable)
Puts all key/value pairs from a given iterable into this map.
|
boolean |
putIfAbsent(int key,
short value)
Trove-inspired API method.
|
short |
putOrAdd(int key,
short putValue,
short incrementValue)
If
key exists, putValue is inserted into the map,
otherwise any existing value is incremented by additionValue . |
protected void |
rehash(int[] fromKeys,
short[] fromValues)
Rehash from old buffers to new buffers.
|
void |
release()
Removes all elements from the collection and additionally releases any
internal buffers.
|
short |
remove(int key)
Remove all values at the given key.
|
int |
removeAll(IntContainer other)
Removes all keys (and associated values) present in a given container.
|
int |
removeAll(IntPredicate predicate)
Removes all keys (and associated values) for which the predicate returns
true . |
int |
removeAll(IntShortPredicate 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.
|
ShortCollection |
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 int[] keys
public short[] values
protected int keyMixer
hashKey(int)
,
"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 IntShortHashMap()
public IntShortHashMap(int expectedElements)
expectedElements
- The expected number of elements guaranteed not to cause buffer
expansion (inclusive).public IntShortHashMap(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 IntShortHashMap(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 IntShortHashMap(IntShortAssociativeContainer container)
public short put(int key, short value)
put
in interface IntShortMap
public int putAll(IntShortAssociativeContainer container)
putAll
in interface IntShortMap
public int putAll(java.lang.Iterable<? extends IntShortCursor> iterable)
putAll
in interface IntShortMap
public boolean putIfAbsent(int key, short 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 short putOrAdd(int key, short putValue, short incrementValue)
key
exists, putValue
is inserted into the map,
otherwise any existing value is incremented by additionValue
.putOrAdd
in interface IntShortMap
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 short addTo(int key, short incrementValue)
incrementValue
to any existing value for the given key
or inserts incrementValue
if key
did not previously exist.addTo
in interface IntShortMap
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 short remove(int key)
remove
in interface IntShortMap
public int removeAll(IntContainer other)
keys().removeAll(container)but with no additional overhead.
removeAll
in interface IntShortAssociativeContainer
public int removeAll(IntShortPredicate predicate)
true
.removeAll
in interface IntShortAssociativeContainer
public int removeAll(IntPredicate predicate)
true
.removeAll
in interface IntShortAssociativeContainer
public short get(int key)
get
in interface IntShortMap
public short getOrDefault(int key, short defaultValue)
getOrDefault
in interface IntShortMap
public boolean containsKey(int key)
true
if this container has an association to a value
for the given key.containsKey
in interface IntShortAssociativeContainer
public int indexOf(int key)
indexOf
in interface IntShortMap
key
- The key to locate in the map.IntShortMap.indexExists(int)
,
IntShortMap.indexGet(int)
,
IntShortMap.indexInsert(int, int, short)
,
IntShortMap.indexReplace(int, short)
public boolean indexExists(int index)
indexExists
in interface IntShortMap
index
- The index of a given key, as returned from IntShortMap.indexOf(int)
.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).IntShortMap.indexOf(int)
public short indexGet(int index)
indexGet
in interface IntShortMap
index
- The index of an existing key.IntShortMap.indexOf(int)
public short indexReplace(int index, short newValue)
indexReplace
in interface IntShortMap
index
- The index of an existing key.IntShortMap.indexOf(int)
public void indexInsert(int index, int key, short value)
indexInsert
in interface IntShortMap
index
- The index of a previously non-existing key, as returned from
IntShortMap.indexOf(int)
.IntShortMap.indexOf(int)
public void clear()
clear
in interface IntShortMap
IntShortMap.release()
public void release()
IntShortMap.clear()
should be a better alternative since it'll avoid
reallocation.release
in interface IntShortMap
IntShortMap.clear()
public int size()
size
in interface IntShortAssociativeContainer
public boolean isEmpty()
isEmpty
in interface IntShortAssociativeContainer
true
if this hash map contains no assigned
keys.public int hashCode()
hashCode
in interface IntShortMap
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
IntShortMap
and both objects contains exactly the same key-value
pairs.equals
in interface IntShortMap
equals
in class java.lang.Object
protected boolean equalElements(IntShortHashMap other)
public void ensureCapacity(int expectedElements)
ensureCapacity
in interface Preallocable
expectedElements
- The total number of keys, inclusive.public java.util.Iterator<IntShortCursor> 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 IntShortAssociativeContainer
iterator
in interface java.lang.Iterable<IntShortCursor>
public <T extends IntShortProcedure> T forEach(T procedure)
IntShortProcedure
. 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 IntShortAssociativeContainer
public <T extends IntShortPredicate> T forEach(T predicate)
IntShortPredicate
. 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 IntShortAssociativeContainer
public IntShortHashMap.KeysContainer keys()
ObjectLookupContainer
.keys
in interface IntShortAssociativeContainer
public ShortCollection values()
IntShortAssociativeContainer
values
in interface IntShortAssociativeContainer
public IntShortHashMap clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static IntShortHashMap from(int[] keys, short[] values)
protected int hashKey(int 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(int[] fromKeys, short[] fromValues)
protected void allocateBuffers(int arraySize)
protected void allocateThenInsertThenRehash(int slot, int pendingKey, short pendingValue)
protected void shiftConflictingKeys(int gapSlot)
slot
.Copyright © 2015 Carrot Search s.c.. All Rights Reserved.