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