Package gnu.trove.map.hash
Class TIntIntHashMap
- java.lang.Object
-
- gnu.trove.impl.hash.THash
-
- gnu.trove.impl.hash.TPrimitiveHash
-
- gnu.trove.impl.hash.TIntIntHash
-
- gnu.trove.map.hash.TIntIntHashMap
-
- All Implemented Interfaces:
TIntIntMap
,java.io.Externalizable
,java.io.Serializable
public class TIntIntHashMap extends TIntIntHash implements TIntIntMap, java.io.Externalizable
An open addressed Map implementation for int keys and int values.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
TIntIntHashMap.TKeyView
a view onto the keys of the map.protected class
TIntIntHashMap.TValueView
a view onto the values of the map.
-
Field Summary
Fields Modifier and Type Field Description protected int[]
_values
the values of the map-
Fields inherited from class gnu.trove.impl.hash.TIntIntHash
_set, consumeFreeSlot, no_entry_key, no_entry_value
-
Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash
_states, FREE, FULL, 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 TIntIntHashMap()
Creates a newTIntIntHashMap
instance with the default capacity and load factor.TIntIntHashMap(int initialCapacity)
Creates a newTIntIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.TIntIntHashMap(int[] keys, int[] values)
Creates a newTIntIntHashMap
instance containing all of the entries in the map passed in.TIntIntHashMap(int initialCapacity, float loadFactor)
Creates a newTIntIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TIntIntHashMap(int initialCapacity, float loadFactor, int noEntryKey, int noEntryValue)
Creates a newTIntIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TIntIntHashMap(TIntIntMap map)
Creates a newTIntIntHashMap
instance containing all of the entries in the map passed in.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
adjustOrPutValue(int key, int adjust_amount, int put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map.boolean
adjustValue(int key, int amount)
Adjusts the primitive value mapped to key.void
clear()
Empties the collection.boolean
containsKey(int 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)
boolean
forEachEntry(TIntIntProcedure procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.boolean
forEachValue(TIntProcedure procedure)
Executes procedure for each value in the map.int
get(int key)
Retrieves the value for key.int
hashCode()
boolean
increment(int key)
Increments the primitive value mapped to key by 1boolean
isEmpty()
Tells whether this set is currently holding any elements.TIntIntIterator
iterator()
int[]
keys()
Returns the keys of the map as an array of int values.int[]
keys(int[] array)
Returns the keys of the map.TIntSet
keySet()
Returns the keys of the map as a TIntSetint
put(int key, int value)
Inserts a key/value pair into the map.void
putAll(TIntIntMap map)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Integer> map)
Put all the entries from the given Map into this map.int
putIfAbsent(int 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 set.int
remove(int key)
Deletes a key/value pair from the map.protected void
removeAt(int index)
Releases the element currently stored at index.boolean
retainEntries(TIntIntProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.protected 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 the values of the map as a TIntCollectionint[]
values()
Returns the values of the map as an array of #e# 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.TIntIntHash
contains, forEach, getNoEntryKey, getNoEntryValue, index, insertKey, XinsertKey
-
Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash
capacity
-
Methods inherited from class gnu.trove.impl.hash.THash
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, fastCeil, getAutoCompactionFactor, 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.TIntIntMap
getNoEntryKey, getNoEntryValue, size
-
-
-
-
Constructor Detail
-
TIntIntHashMap
public TIntIntHashMap()
Creates a newTIntIntHashMap
instance with the default capacity and load factor.
-
TIntIntHashMap
public TIntIntHashMap(int initialCapacity)
Creates a newTIntIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.- Parameters:
initialCapacity
- anint
value
-
TIntIntHashMap
public TIntIntHashMap(int initialCapacity, float loadFactor)
Creates a newTIntIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
value
-
TIntIntHashMap
public TIntIntHashMap(int initialCapacity, float loadFactor, int noEntryKey, int noEntryValue)
Creates a newTIntIntHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
valuenoEntryKey
- aint
value that represents null for the Key set.noEntryValue
- aint
value that represents null for the Value set.
-
TIntIntHashMap
public TIntIntHashMap(int[] keys, int[] values)
Creates a newTIntIntHashMap
instance containing all of the entries in the map passed in.- Parameters:
keys
- a int array containing the keys for the matching values.values
- a int array containing the values.
-
TIntIntHashMap
public TIntIntHashMap(TIntIntMap map)
Creates a newTIntIntHashMap
instance containing all of the entries in the map passed in.- Parameters:
map
- a TIntIntMap that will be duplicated.
-
-
Method Detail
-
setUp
protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.- Overrides:
setUp
in classTIntIntHash
- Parameters:
initialCapacity
- anint
value- Returns:
- the actual capacity chosen
-
rehash
protected void rehash(int newCapacity)
Rehashes the set.
-
put
public int put(int key, int value)
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTIntIntMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TIntIntMap.getNoEntryValue()
).
-
putIfAbsent
public int putIfAbsent(int 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 interfaceTIntIntMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TIntIntMap.getNoEntryValue()
).
-
putAll
public void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Integer> map)
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTIntIntMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
putAll
public void putAll(TIntIntMap map)
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTIntIntMap
- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
get
public int get(int key)
Retrieves the value for key.- Specified by:
get
in interfaceTIntIntMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TIntIntMap.getNoEntryValue()
).
-
clear
public void clear()
Empties the collection.- Specified by:
clear
in interfaceTIntIntMap
- Overrides:
clear
in classTHash
-
isEmpty
public boolean isEmpty()
Tells whether this set is currently holding any elements.- Specified by:
isEmpty
in interfaceTIntIntMap
- Overrides:
isEmpty
in classTHash
- Returns:
- a
boolean
value
-
remove
public int remove(int key)
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTIntIntMap
- Parameters:
key
- anint
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TIntIntMap.getNoEntryValue()
).
-
removeAt
protected void removeAt(int index)
Releases the element currently stored at index.- Overrides:
removeAt
in classTIntIntHash
- Parameters:
index
- anint
value
-
keySet
public TIntSet keySet()
Returns the keys of the map as a TIntSet- Specified by:
keySet
in interfaceTIntIntMap
- Returns:
- the keys of the map as a TIntSet
-
keys
public int[] keys()
Returns the keys of the map as an array of int values.- Specified by:
keys
in interfaceTIntIntMap
- Returns:
- the keys of the map as an array of int values.
-
keys
public int[] keys(int[] array)
Returns the keys of the map.- Specified by:
keys
in interfaceTIntIntMap
- 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 keys of the map as an array.
-
valueCollection
public TIntCollection valueCollection()
Returns the values of the map as a TIntCollection- Specified by:
valueCollection
in interfaceTIntIntMap
- Returns:
- the values of the map as a TIntCollection
-
values
public int[] values()
Returns the values of the map as an array of #e# values.- Specified by:
values
in interfaceTIntIntMap
- Returns:
- the values of the map as an array of #e# values.
-
values
public int[] values(int[] array)
Returns the values of the map using an existing array.- Specified by:
values
in interfaceTIntIntMap
- 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 #e# values.
-
containsValue
public boolean containsValue(int val)
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTIntIntMap
-
containsKey
public boolean containsKey(int key)
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTIntIntMap
-
iterator
public TIntIntIterator iterator()
- Specified by:
iterator
in interfaceTIntIntMap
- Returns:
- a TIntIntIterator with access to this map's keys and values
-
forEachKey
public boolean forEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTIntIntMap
- Parameters:
procedure
- aTIntProcedure
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 interfaceTIntIntMap
- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
public boolean forEachEntry(TIntIntProcedure procedure)
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTIntIntMap
- Parameters:
procedure
- aTOIntIntProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
transformValues
public void transformValues(TIntFunction function)
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTIntIntMap
- Parameters:
function
- aTIntFunction
value
-
retainEntries
public boolean retainEntries(TIntIntProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTIntIntMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(int key)
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTIntIntMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(int key, int amount)
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTIntIntMap
- Parameters:
key
- the key of the value to incrementamount
- the amount to adjust the value by.- Returns:
- true if a mapping was found and modified.
-
adjustOrPutValue
public int adjustOrPutValue(int key, int adjust_amount, int put_amount)
Adjusts 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 interfaceTIntIntMap
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to adjust the value byput_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
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Overrides:
writeExternal
in classTIntIntHash
- 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 classTIntIntHash
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-