Package gnu.trove.map.hash
Class TObjectDoubleHashMap<K>
java.lang.Object
gnu.trove.impl.hash.THash
gnu.trove.impl.hash.TObjectHash<K>
gnu.trove.map.hash.TObjectDoubleHashMap<K>
- All Implemented Interfaces:
TObjectDoubleMap<K>
,Externalizable
,Serializable
public class TObjectDoubleHashMap<K>
extends TObjectHash<K>
implements TObjectDoubleMap<K>, Externalizable
An open addressed Map implementation for Object keys and double values.
Created: Sun Nov 4 08:52:45 2001
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
a view onto the keys of the map. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected double[]
the values of the mapprotected double
the value that represents nullFields inherited from class gnu.trove.impl.hash.TObjectHash
_set, consumeFreeSlot, FREE, REMOVED
Fields inherited from class gnu.trove.impl.hash.THash
_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a newTObjectDoubleHashMap
instance with the default capacity and load factor.TObjectDoubleHashMap
(int initialCapacity) Creates a newTObjectDoubleHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.TObjectDoubleHashMap
(int initialCapacity, float loadFactor) Creates a newTObjectDoubleHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TObjectDoubleHashMap
(int initialCapacity, float loadFactor, double noEntryValue) Creates a newTObjectDoubleHashMap
instance with a prime value at or near the specified capacity and load factor.TObjectDoubleHashMap
(TObjectDoubleMap<? extends K> map) Creates a newTObjectDoubleHashMap
that contains the entries in the map passed to it. -
Method Summary
Modifier and TypeMethodDescriptiondouble
adjustOrPutValue
(K key, double adjust_amount, double put_amount) Adds an amount to the primitive value mapped to the key if the key is present in the map.boolean
adjustValue
(K key, double amount) Adds an amount to the primitive value mapped to key.void
clear()
Empties the collection.boolean
containsKey
(Object 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
Compares this map with another map for equality of their stored entries.boolean
forEachEntry
(TObjectDoubleProcedure<? super K> procedure) Executes procedure for each key/value entry in the map.boolean
forEachKey
(TObjectProcedure<? super K> procedure) Executes procedure for each key in the map.boolean
forEachValue
(TDoubleProcedure procedure) Executes procedure for each value in the map.double
Retrieves the value for key.double
Returns the value that will be returned fromTObjectDoubleMap.get(java.lang.Object)
orTObjectDoubleMap.put(K, double)
if no entry exists for a given key.int
hashCode()
Returns the hash code value for this map.boolean
Increments the primitive value mapped to key by 1iterator()
Returns a TObjectDoubleIterator with access to this map's keys and values.Object[]
keys()
Returns a copy of the keys of the map as an array.K[]
Returns a copy of the keys of the map as an array.keySet()
Returns aSet
view of the keys contained in this map.double
Inserts a key/value pair into the map.void
putAll
(TObjectDoubleMap<? extends K> map) Put all the entries from the given map into this map.void
Copies all of the mappings from the specified map to this map (optional operation).double
putIfAbsent
(K key, double value) Inserts a key/value pair into the map if the specified key is not already associated with a value.void
protected void
rehash
(int newCapacity) rehashes the map to the new capacity.double
Deletes a key/value pair from the map.protected void
removeAt
(int index) Removes the mapping at index from the map.boolean
retainEntries
(TObjectDoubleProcedure<? super K> procedure) Retains only those entries in the map for which the procedure returns a true value.int
setUp
(int initialCapacity) initializes the hashtable to a prime capacity which is at least initialCapacity + 1.toString()
void
transformValues
(TDoubleFunction function) Transform the values in this map using function.Returns aTDoubleCollection
view of the values contained in this map.double[]
values()
Returns the values of the map as an array of double values.double[]
values
(double[] array) Returns the values of the map using an existing array.void
Methods inherited from class gnu.trove.impl.hash.TObjectHash
buildObjectContractViolation, capacity, contains, dumpExtraInfo, equals, forEach, hash, index, insertionIndex, insertKey, objectInfo, reportPotentialConcurrentMod, throwObjectContractViolation, throwObjectContractViolation
Methods inherited from class gnu.trove.impl.hash.THash
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, fastCeil, getAutoCompactionFactor, isEmpty, 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.TObjectDoubleMap
isEmpty, size
-
Field Details
-
_values
protected transient double[] _valuesthe values of the map -
no_entry_value
protected double no_entry_valuethe value that represents null
-
-
Constructor Details
-
TObjectDoubleHashMap
public TObjectDoubleHashMap()Creates a newTObjectDoubleHashMap
instance with the default capacity and load factor. -
TObjectDoubleHashMap
public TObjectDoubleHashMap(int initialCapacity) Creates a newTObjectDoubleHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.- Parameters:
initialCapacity
- anint
value
-
TObjectDoubleHashMap
public TObjectDoubleHashMap(int initialCapacity, float loadFactor) Creates a newTObjectDoubleHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
value
-
TObjectDoubleHashMap
public TObjectDoubleHashMap(int initialCapacity, float loadFactor, double noEntryValue) Creates a newTObjectDoubleHashMap
instance with a prime value at or near the specified capacity and load factor.- Parameters:
initialCapacity
- used to find a prime capacity for the table.loadFactor
- used to calculate the threshold over which rehashing takes place.noEntryValue
- the value used to represent null.
-
TObjectDoubleHashMap
Creates a newTObjectDoubleHashMap
that contains the entries in the map passed to it.- Parameters:
map
- the TObjectDoubleMap to be copied.
-
-
Method Details
-
setUp
public int setUp(int initialCapacity) initializes the hashtable to a prime capacity which is at least initialCapacity + 1.- Overrides:
setUp
in classTObjectHash<K>
- Parameters:
initialCapacity
- anint
value- Returns:
- the actual capacity chosen
-
rehash
protected void rehash(int newCapacity) rehashes the map to the new capacity. -
getNoEntryValue
public double getNoEntryValue()Returns the value that will be returned fromTObjectDoubleMap.get(java.lang.Object)
orTObjectDoubleMap.put(K, double)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Specified by:
getNoEntryValue
in interfaceTObjectDoubleMap<K>
- Returns:
- the value that represents a null value in this collection.
-
containsKey
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTObjectDoubleMap<K>
-
containsValue
public boolean containsValue(double val) Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTObjectDoubleMap<K>
-
get
Retrieves the value for key.- Specified by:
get
in interfaceTObjectDoubleMap<K>
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectDoubleMap.getNoEntryValue()
).
-
put
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTObjectDoubleMap<K>
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectDoubleMap.getNoEntryValue()
).
-
putIfAbsent
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTObjectDoubleMap<K>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- an double value to be associated with the specified key- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectDoubleMap.getNoEntryValue()
).
-
remove
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTObjectDoubleMap<K>
- Parameters:
key
- an#k#
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectDoubleMap.getNoEntryValue()
).
-
removeAt
protected void removeAt(int index) Removes the mapping at index from the map. This method is used internally and public mainly because of packaging reasons. Caveat Programmer.- Overrides:
removeAt
in classTObjectHash<K>
- Parameters:
index
- anint
value
-
putAll
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Specified by:
putAll
in interfaceTObjectDoubleMap<K>
- Parameters:
map
- mappings to be stored in this map
-
putAll
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTObjectDoubleMap<K>
- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
clear
public void clear()Empties the collection.- Specified by:
clear
in interfaceTObjectDoubleMap<K>
- Overrides:
clear
in classTHash
-
keySet
Returns aSet
view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.- Specified by:
keySet
in interfaceTObjectDoubleMap<K>
- Returns:
- a set view of the keys contained in this map
-
keys
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Specified by:
keys
in interfaceTObjectDoubleMap<K>
- Returns:
- a copy of the keys of the map as an array.
-
keys
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Specified by:
keys
in interfaceTObjectDoubleMap<K>
- Parameters:
a
- 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
Returns aTDoubleCollection
view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the TDoubleIterator.remove, TDoubleCollection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.- Specified by:
valueCollection
in interfaceTObjectDoubleMap<K>
- Returns:
- a collection view of the values contained in this map
-
values
public double[] values()Returns the values of the map as an array of double values. Changes to the array of values will not be reflected in the map nor vice-versa.- Specified by:
values
in interfaceTObjectDoubleMap<K>
- Returns:
- the values of the map as an array of double values.
-
values
public double[] values(double[] array) Returns the values of the map using an existing array. Changes to the array of values will not be reflected in the map nor vice-versa.- Specified by:
values
in interfaceTObjectDoubleMap<K>
- 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 double values.
-
iterator
Description copied from interface:TObjectDoubleMap
Returns a TObjectDoubleIterator with access to this map's keys and values.- Specified by:
iterator
in interfaceTObjectDoubleMap<K>
- Returns:
- an iterator over the entries in this map
-
increment
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTObjectDoubleMap<K>
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
Adds an amount to the primitive value mapped to key. If the key does not exist, the map is not modified (key-value is not inserted).- Specified by:
adjustValue
in interfaceTObjectDoubleMap<K>
- Parameters:
key
- the key of the value to incrementamount
- the amount to add to the value; may be positive, zero, or negative- Returns:
- true if a mapping was found and modified
- See Also:
-
adjustOrPutValue
Adds an amount to 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 interfaceTObjectDoubleMap<K>
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to add to the value; may be positive, zero, or negativeput_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
-
forEachKey
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTObjectDoubleMap<K>
- Parameters:
procedure
- aTObjectProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTObjectDoubleMap<K>
- Parameters:
procedure
- aTDoubleProcedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTObjectDoubleMap<K>
- Parameters:
procedure
- aTOObjectDoubleProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
retainEntries
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTObjectDoubleMap<K>
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
transformValues
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTObjectDoubleMap<K>
- Parameters:
function
- aTDoubleFunction
value
-
equals
Compares this map with another map for equality of their stored entries.- Specified by:
equals
in interfaceTObjectDoubleMap<K>
- Overrides:
equals
in classObject
- Parameters:
other
- anObject
value- Returns:
- a
boolean
value
-
hashCode
public int hashCode()Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract ofObject.hashCode()
.- Specified by:
hashCode
in interfaceTObjectDoubleMap<K>
- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this map
- See Also:
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Overrides:
writeExternal
in classTObjectHash<K>
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Overrides:
readExternal
in classTObjectHash<K>
- Throws:
IOException
ClassNotFoundException
-
toString
-