Package gnu.trove.map.hash
Class TObjectIntHashMap<K>
- java.lang.Object
-
- gnu.trove.impl.hash.THash
-
- gnu.trove.impl.hash.TObjectHash<K>
-
- gnu.trove.map.hash.TObjectIntHashMap<K>
-
- All Implemented Interfaces:
TObjectIntMap<K>
,java.io.Externalizable
,java.io.Serializable
public class TObjectIntHashMap<K> extends TObjectHash<K> implements TObjectIntMap<K>, java.io.Externalizable
An open addressed Map implementation for Object keys and int values. Created: Sun Nov 4 08:52:45 2001- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
TObjectIntHashMap.KeyView
a view onto the keys of the map.
-
Field Summary
Fields Modifier and Type Field Description protected int[]
_values
the values of the mapprotected int
no_entry_value
the value that represents null-
Fields inherited from class gnu.trove.impl.hash.TObjectHash
_set, consumeFreeSlot, FREE, REMOVED
-
Fields inherited from class gnu.trove.impl.hash.THash
_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR
-
-
Constructor Summary
Constructors Constructor Description TObjectIntHashMap()
Creates a newTObjectIntHashMap
instance with the default capacity and load factor.TObjectIntHashMap(int initialCapacity)
Creates a newTObjectIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.TObjectIntHashMap(int initialCapacity, float loadFactor)
Creates a newTObjectIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TObjectIntHashMap(int initialCapacity, float loadFactor, int noEntryValue)
Creates a newTObjectIntHashMap
instance with a prime value at or near the specified capacity and load factor.TObjectIntHashMap(TObjectIntMap<? extends K> map)
Creates a newTObjectIntHashMap
that contains the entries in the map passed to it.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
adjustOrPutValue(K key, int adjust_amount, int put_amount)
Adds an amount to the primitive value mapped to the key if the key is present in the map.boolean
adjustValue(K key, int amount)
Adds an amount to the primitive value mapped to key.void
clear()
Empties the collection.boolean
containsKey(java.lang.Object key)
Checks for the present of key in the keys of the map.boolean
containsValue(int val)
Checks for the presence of val in the values of the map.boolean
equals(java.lang.Object other)
Compares this map with another map for equality of their stored entries.boolean
forEachEntry(TObjectIntProcedure<? super K> procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TObjectProcedure<? super K> procedure)
Executes procedure for each key in the map.boolean
forEachValue(TIntProcedure procedure)
Executes procedure for each value in the map.int
get(java.lang.Object key)
Retrieves the value for key.int
getNoEntryValue()
Returns the value that will be returned fromTObjectIntMap.get(java.lang.Object)
orTObjectIntMap.put(K, int)
if no entry exists for a given key.int
hashCode()
Returns the hash code value for this map.boolean
increment(K key)
Increments the primitive value mapped to key by 1TObjectIntIterator<K>
iterator()
Returns a TObjectIntIterator with access to this map's keys and values.java.lang.Object[]
keys()
Returns a copy of the keys of the map as an array.K[]
keys(K[] a)
Returns a copy of the keys of the map as an array.java.util.Set<K>
keySet()
Returns aSet
view of the keys contained in this map.int
put(K key, int value)
Inserts a key/value pair into the map.void
putAll(TObjectIntMap<? extends K> map)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends K,? extends java.lang.Integer> map)
Copies all of the mappings from the specified map to this map (optional operation).int
putIfAbsent(K key, int value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.void
readExternal(java.io.ObjectInput in)
protected void
rehash(int newCapacity)
rehashes the map to the new capacity.int
remove(java.lang.Object key)
Deletes a key/value pair from the map.protected void
removeAt(int index)
Removes the mapping at index from the map.boolean
retainEntries(TObjectIntProcedure<? super K> procedure)
Retains only those entries in the map for which the procedure returns a true value.int
setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.java.lang.String
toString()
void
transformValues(TIntFunction function)
Transform the values in this map using function.TIntCollection
valueCollection()
Returns aTIntCollection
view of the values contained in this map.int[]
values()
Returns the values of the map as an array of int values.int[]
values(int[] array)
Returns the values of the map using an existing array.void
writeExternal(java.io.ObjectOutput out)
-
Methods inherited from class gnu.trove.impl.hash.TObjectHash
buildObjectContractViolation, capacity, contains, dumpExtraInfo, equals, forEach, hash, index, insertionIndex, insertKey, objectInfo, reportPotentialConcurrentMod, throwObjectContractViolation, throwObjectContractViolation
-
Methods inherited from class gnu.trove.impl.hash.THash
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, fastCeil, getAutoCompactionFactor, isEmpty, postInsertHook, reenableAutoCompaction, saturatedCast, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface gnu.trove.map.TObjectIntMap
isEmpty, size
-
-
-
-
Constructor Detail
-
TObjectIntHashMap
public TObjectIntHashMap()
Creates a newTObjectIntHashMap
instance with the default capacity and load factor.
-
TObjectIntHashMap
public TObjectIntHashMap(int initialCapacity)
Creates a newTObjectIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.- Parameters:
initialCapacity
- anint
value
-
TObjectIntHashMap
public TObjectIntHashMap(int initialCapacity, float loadFactor)
Creates a newTObjectIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
value
-
TObjectIntHashMap
public TObjectIntHashMap(int initialCapacity, float loadFactor, int noEntryValue)
Creates a newTObjectIntHashMap
instance with a prime value at or near the specified capacity and load factor.- Parameters:
initialCapacity
- used to find a prime capacity for the table.loadFactor
- used to calculate the threshold over which rehashing takes place.noEntryValue
- the value used to represent null.
-
TObjectIntHashMap
public TObjectIntHashMap(TObjectIntMap<? extends K> map)
Creates a newTObjectIntHashMap
that contains the entries in the map passed to it.- Parameters:
map
- the TObjectIntMap to be copied.
-
-
Method Detail
-
setUp
public int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.- Overrides:
setUp
in classTObjectHash<K>
- Parameters:
initialCapacity
- anint
value- Returns:
- the actual capacity chosen
-
rehash
protected void rehash(int newCapacity)
rehashes the map to the new capacity.
-
getNoEntryValue
public int getNoEntryValue()
Returns the value that will be returned fromTObjectIntMap.get(java.lang.Object)
orTObjectIntMap.put(K, int)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Specified by:
getNoEntryValue
in interfaceTObjectIntMap<K>
- Returns:
- the value that represents a null value in this collection.
-
containsKey
public boolean containsKey(java.lang.Object key)
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTObjectIntMap<K>
-
containsValue
public boolean containsValue(int val)
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTObjectIntMap<K>
-
get
public int get(java.lang.Object key)
Retrieves the value for key.- Specified by:
get
in interfaceTObjectIntMap<K>
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectIntMap.getNoEntryValue()
).
-
put
public int put(K key, int value)
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTObjectIntMap<K>
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectIntMap.getNoEntryValue()
).
-
putIfAbsent
public int putIfAbsent(K key, int value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTObjectIntMap<K>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- an int value to be associated with the specified key- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectIntMap.getNoEntryValue()
).
-
remove
public int remove(java.lang.Object key)
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTObjectIntMap<K>
- Parameters:
key
- an#k#
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectIntMap.getNoEntryValue()
).
-
removeAt
protected void removeAt(int index)
Removes the mapping at index from the map. This method is used internally and public mainly because of packaging reasons. Caveat Programmer.- Overrides:
removeAt
in classTObjectHash<K>
- Parameters:
index
- anint
value
-
putAll
public void putAll(java.util.Map<? extends K,? extends java.lang.Integer> map)
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Specified by:
putAll
in interfaceTObjectIntMap<K>
- Parameters:
map
- mappings to be stored in this map
-
putAll
public void putAll(TObjectIntMap<? extends K> map)
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTObjectIntMap<K>
- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
clear
public void clear()
Empties the collection.- Specified by:
clear
in interfaceTObjectIntMap<K>
- Overrides:
clear
in classTHash
-
keySet
public java.util.Set<K> keySet()
Returns aSet
view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.- Specified by:
keySet
in interfaceTObjectIntMap<K>
- Returns:
- a set view of the keys contained in this map
-
keys
public java.lang.Object[] keys()
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Specified by:
keys
in interfaceTObjectIntMap<K>
- Returns:
- a copy of the keys of the map as an array.
-
keys
public K[] keys(K[] a)
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Specified by:
keys
in interfaceTObjectIntMap<K>
- Parameters:
a
- the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.- Returns:
- the keys of the map as an array.
-
valueCollection
public TIntCollection valueCollection()
Returns aTIntCollection
view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the TIntIterator.remove, TIntCollection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.- Specified by:
valueCollection
in interfaceTObjectIntMap<K>
- Returns:
- a collection view of the values contained in this map
-
values
public int[] values()
Returns the values of the map as an array of int values. Changes to the array of values will not be reflected in the map nor vice-versa.- Specified by:
values
in interfaceTObjectIntMap<K>
- Returns:
- the values of the map as an array of int values.
-
values
public int[] values(int[] array)
Returns the values of the map using an existing array. Changes to the array of values will not be reflected in the map nor vice-versa.- Specified by:
values
in interfaceTObjectIntMap<K>
- Parameters:
array
- the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.- Returns:
- the values of the map as an array of int values.
-
iterator
public TObjectIntIterator<K> iterator()
Description copied from interface:TObjectIntMap
Returns a TObjectIntIterator with access to this map's keys and values.- Specified by:
iterator
in interfaceTObjectIntMap<K>
- Returns:
- an iterator over the entries in this map
-
increment
public boolean increment(K key)
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTObjectIntMap<K>
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(K key, int amount)
Adds an amount to the primitive value mapped to key. If the key does not exist, the map is not modified (key-value is not inserted).- Specified by:
adjustValue
in interfaceTObjectIntMap<K>
- Parameters:
key
- the key of the value to incrementamount
- the amount to add to the value; may be positive, zero, or negative- Returns:
- true if a mapping was found and modified
- See Also:
TObjectIntMap.adjustOrPutValue(Object, int, int)
-
adjustOrPutValue
public int adjustOrPutValue(K key, int adjust_amount, int put_amount)
Adds an amount to the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.- Specified by:
adjustOrPutValue
in interfaceTObjectIntMap<K>
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to add to the value; may be positive, zero, or negativeput_amount
- the value put into the map if the key is not present- Returns:
- the value present in the map after the adjustment or put operation
-
forEachKey
public boolean forEachKey(TObjectProcedure<? super K> procedure)
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTObjectIntMap<K>
- Parameters:
procedure
- aTObjectProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
public boolean forEachValue(TIntProcedure procedure)
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTObjectIntMap<K>
- Parameters:
procedure
- aTIntProcedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
public boolean forEachEntry(TObjectIntProcedure<? super K> procedure)
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTObjectIntMap<K>
- Parameters:
procedure
- aTOObjectIntProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
retainEntries
public boolean retainEntries(TObjectIntProcedure<? super K> procedure)
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTObjectIntMap<K>
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
transformValues
public void transformValues(TIntFunction function)
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTObjectIntMap<K>
- Parameters:
function
- aTIntFunction
value
-
equals
public boolean equals(java.lang.Object other)
Compares this map with another map for equality of their stored entries.- Specified by:
equals
in interfaceTObjectIntMap<K>
- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
- anObject
value- Returns:
- a
boolean
value
-
hashCode
public int hashCode()
Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract ofObject.hashCode()
.- Specified by:
hashCode
in interfaceTObjectIntMap<K>
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- the hash code value for this map
- See Also:
Object.equals(Object)
,TObjectIntMap.equals(Object)
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Overrides:
writeExternal
in classTObjectHash<K>
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Overrides:
readExternal
in classTObjectHash<K>
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-