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