Package gnu.trove.map.hash
Class TCharShortHashMap
- java.lang.Object
-
- gnu.trove.impl.hash.THash
-
- gnu.trove.impl.hash.TPrimitiveHash
-
- gnu.trove.impl.hash.TCharShortHash
-
- gnu.trove.map.hash.TCharShortHashMap
-
- All Implemented Interfaces:
TCharShortMap
,java.io.Externalizable
,java.io.Serializable
public class TCharShortHashMap extends TCharShortHash implements TCharShortMap, java.io.Externalizable
An open addressed Map implementation for char keys and short values.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
TCharShortHashMap.TKeyView
a view onto the keys of the map.protected class
TCharShortHashMap.TValueView
a view onto the values of the map.
-
Field Summary
Fields Modifier and Type Field Description protected short[]
_values
the values of the map-
Fields inherited from class gnu.trove.impl.hash.TCharShortHash
_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 TCharShortHashMap()
Creates a newTCharShortHashMap
instance with the default capacity and load factor.TCharShortHashMap(char[] keys, short[] values)
Creates a newTCharShortHashMap
instance containing all of the entries in the map passed in.TCharShortHashMap(int initialCapacity)
Creates a newTCharShortHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.TCharShortHashMap(int initialCapacity, float loadFactor)
Creates a newTCharShortHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TCharShortHashMap(int initialCapacity, float loadFactor, char noEntryKey, short noEntryValue)
Creates a newTCharShortHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TCharShortHashMap(TCharShortMap map)
Creates a newTCharShortHashMap
instance containing all of the entries in the map passed in.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description short
adjustOrPutValue(char key, short adjust_amount, short put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map.boolean
adjustValue(char key, short amount)
Adjusts the primitive value mapped to key.void
clear()
Empties the collection.boolean
containsKey(char key)
Checks for the present of key in the keys of the map.boolean
containsValue(short val)
Checks for the presence of val in the values of the map.boolean
equals(java.lang.Object other)
boolean
forEachEntry(TCharShortProcedure procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TCharProcedure procedure)
Executes procedure for each key in the map.boolean
forEachValue(TShortProcedure procedure)
Executes procedure for each value in the map.short
get(char key)
Retrieves the value for key.int
hashCode()
boolean
increment(char key)
Increments the primitive value mapped to key by 1boolean
isEmpty()
Tells whether this set is currently holding any elements.TCharShortIterator
iterator()
char[]
keys()
Returns the keys of the map as an array of char values.char[]
keys(char[] array)
Returns the keys of the map.TCharSet
keySet()
Returns the keys of the map as a TCharSetshort
put(char key, short value)
Inserts a key/value pair into the map.void
putAll(TCharShortMap map)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map)
Put all the entries from the given Map into this map.short
putIfAbsent(char key, short 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.short
remove(char key)
Deletes a key/value pair from the map.protected void
removeAt(int index)
Releases the element currently stored at index.boolean
retainEntries(TCharShortProcedure 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(TShortFunction function)
Transform the values in this map using function.TShortCollection
valueCollection()
Returns the values of the map as a TShortCollectionshort[]
values()
Returns the values of the map as an array of #e# values.short[]
values(short[] 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.TCharShortHash
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.TCharShortMap
getNoEntryKey, getNoEntryValue, size
-
-
-
-
Constructor Detail
-
TCharShortHashMap
public TCharShortHashMap()
Creates a newTCharShortHashMap
instance with the default capacity and load factor.
-
TCharShortHashMap
public TCharShortHashMap(int initialCapacity)
Creates a newTCharShortHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.- Parameters:
initialCapacity
- anint
value
-
TCharShortHashMap
public TCharShortHashMap(int initialCapacity, float loadFactor)
Creates a newTCharShortHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
value
-
TCharShortHashMap
public TCharShortHashMap(int initialCapacity, float loadFactor, char noEntryKey, short noEntryValue)
Creates a newTCharShortHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
valuenoEntryKey
- achar
value that represents null for the Key set.noEntryValue
- ashort
value that represents null for the Value set.
-
TCharShortHashMap
public TCharShortHashMap(char[] keys, short[] values)
Creates a newTCharShortHashMap
instance containing all of the entries in the map passed in.- Parameters:
keys
- a char array containing the keys for the matching values.values
- a short array containing the values.
-
TCharShortHashMap
public TCharShortHashMap(TCharShortMap map)
Creates a newTCharShortHashMap
instance containing all of the entries in the map passed in.- Parameters:
map
- a TCharShortMap 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 classTCharShortHash
- Parameters:
initialCapacity
- anint
value- Returns:
- the actual capacity chosen
-
rehash
protected void rehash(int newCapacity)
Rehashes the set.
-
put
public short put(char key, short value)
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTCharShortMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharShortMap.getNoEntryValue()
).
-
putIfAbsent
public short putIfAbsent(char key, short value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTCharShortMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharShortMap.getNoEntryValue()
).
-
putAll
public void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map)
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTCharShortMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
putAll
public void putAll(TCharShortMap map)
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTCharShortMap
- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
get
public short get(char key)
Retrieves the value for key.- Specified by:
get
in interfaceTCharShortMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharShortMap.getNoEntryValue()
).
-
clear
public void clear()
Empties the collection.- Specified by:
clear
in interfaceTCharShortMap
- Overrides:
clear
in classTHash
-
isEmpty
public boolean isEmpty()
Tells whether this set is currently holding any elements.- Specified by:
isEmpty
in interfaceTCharShortMap
- Overrides:
isEmpty
in classTHash
- Returns:
- a
boolean
value
-
remove
public short remove(char key)
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTCharShortMap
- Parameters:
key
- anchar
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharShortMap.getNoEntryValue()
).
-
removeAt
protected void removeAt(int index)
Releases the element currently stored at index.- Overrides:
removeAt
in classTCharShortHash
- Parameters:
index
- anint
value
-
keySet
public TCharSet keySet()
Returns the keys of the map as a TCharSet- Specified by:
keySet
in interfaceTCharShortMap
- Returns:
- the keys of the map as a TCharSet
-
keys
public char[] keys()
Returns the keys of the map as an array of char values.- Specified by:
keys
in interfaceTCharShortMap
- Returns:
- the keys of the map as an array of char values.
-
keys
public char[] keys(char[] array)
Returns the keys of the map.- Specified by:
keys
in interfaceTCharShortMap
- 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 TShortCollection valueCollection()
Returns the values of the map as a TShortCollection- Specified by:
valueCollection
in interfaceTCharShortMap
- Returns:
- the values of the map as a TShortCollection
-
values
public short[] values()
Returns the values of the map as an array of #e# values.- Specified by:
values
in interfaceTCharShortMap
- Returns:
- the values of the map as an array of #e# values.
-
values
public short[] values(short[] array)
Returns the values of the map using an existing array.- Specified by:
values
in interfaceTCharShortMap
- 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(short val)
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTCharShortMap
-
containsKey
public boolean containsKey(char key)
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTCharShortMap
-
iterator
public TCharShortIterator iterator()
- Specified by:
iterator
in interfaceTCharShortMap
- Returns:
- a TCharShortIterator with access to this map's keys and values
-
forEachKey
public boolean forEachKey(TCharProcedure procedure)
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTCharShortMap
- Parameters:
procedure
- aTCharProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
public boolean forEachValue(TShortProcedure procedure)
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTCharShortMap
- 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(TCharShortProcedure procedure)
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTCharShortMap
- Parameters:
procedure
- aTOCharShortProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
transformValues
public void transformValues(TShortFunction function)
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTCharShortMap
- Parameters:
function
- aTShortFunction
value
-
retainEntries
public boolean retainEntries(TCharShortProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTCharShortMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(char key)
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTCharShortMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(char key, short amount)
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTCharShortMap
- 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 short adjustOrPutValue(char key, short adjust_amount, short 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 interfaceTCharShortMap
- 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 classTCharShortHash
- 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 classTCharShortHash
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-