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