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