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