Class TObjectDoubleCustomHashMap<K>

  • All Implemented Interfaces:
    TObjectDoubleMap<K>, java.io.Externalizable, java.io.Serializable

    public class TObjectDoubleCustomHashMap<K>
    extends TCustomObjectHash<K>
    implements TObjectDoubleMap<K>, java.io.Externalizable
    An open addressed Map implementation for Object keys and double values.
    See Also:
    Serialized Form
    • Field Detail

      • _values

        protected transient double[] _values
        the values of the map
      • no_entry_value

        protected double no_entry_value
        the value that represents null
    • Constructor Detail

      • TObjectDoubleCustomHashMap

        public TObjectDoubleCustomHashMap()
        FOR EXTERNALIZATION ONLY!!!
      • TObjectDoubleCustomHashMap

        public TObjectDoubleCustomHashMap​(HashingStrategy<? super K> strategy)
        Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
      • TObjectDoubleCustomHashMap

        public TObjectDoubleCustomHashMap​(HashingStrategy<? super K> strategy,
                                          int initialCapacity)
        Creates a new TObjectDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
        Parameters:
        initialCapacity - an int value
      • TObjectDoubleCustomHashMap

        public TObjectDoubleCustomHashMap​(HashingStrategy<? super K> strategy,
                                          int initialCapacity,
                                          float loadFactor)
        Creates a new TObjectDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
        Parameters:
        initialCapacity - an int value
        loadFactor - a float value
      • TObjectDoubleCustomHashMap

        public TObjectDoubleCustomHashMap​(HashingStrategy<? super K> strategy,
                                          int initialCapacity,
                                          float loadFactor,
                                          double noEntryValue)
        Creates a new TObjectDoubleHashMap 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.
      • TObjectDoubleCustomHashMap

        public TObjectDoubleCustomHashMap​(HashingStrategy<? super K> strategy,
                                          TObjectDoubleMap<? extends K> map)
        Creates a new TObjectDoubleCustomHashMap that contains the entries in the map passed to it.
        Parameters:
        map - the TObjectDoubleMap to be copied.
    • Method Detail

      • setUp

        public int setUp​(int initialCapacity)
        initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
        Overrides:
        setUp in class TObjectHash<K>
        Parameters:
        initialCapacity - an int value
        Returns:
        the actual capacity chosen
      • rehash

        protected void rehash​(int newCapacity)
        rehashes the map to the new capacity.
        Specified by:
        rehash in class THash
        Parameters:
        newCapacity - an int value
      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Checks for the present of key in the keys of the map.
        Specified by:
        containsKey in interface TObjectDoubleMap<K>
      • containsValue

        public boolean containsValue​(double val)
        Checks for the presence of val in the values of the map.
        Specified by:
        containsValue in interface TObjectDoubleMap<K>
      • put

        public double put​(K key,
                          double value)
        Inserts a key/value pair into the map.
        Specified by:
        put in interface TObjectDoubleMap<K>
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TObjectDoubleMap.getNoEntryValue()).
      • putIfAbsent

        public 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.
        Specified by:
        putIfAbsent in interface TObjectDoubleMap<K>
        Parameters:
        key - key with which the specified value is to be associated
        value - 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

        public double remove​(java.lang.Object key)
        Deletes a key/value pair from the map.
        Specified by:
        remove in interface TObjectDoubleMap<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 class TObjectHash<K>
        Parameters:
        index - an int value
      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends java.lang.Double> map)
        Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(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 interface TObjectDoubleMap<K>
        Parameters:
        map - mappings to be stored in this map
      • putAll

        public void putAll​(TObjectDoubleMap<? extends K> map)
        Put all the entries from the given map into this map.
        Specified by:
        putAll in interface TObjectDoubleMap<K>
        Parameters:
        map - The map from which entries will be obtained to put into this map.
      • keySet

        public java.util.Set<K> keySet()
        Returns a Set 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 interface TObjectDoubleMap<K>
        Returns:
        a set view of the keys contained in this map
      • keys

        public java.lang.Object[] 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 interface TObjectDoubleMap<K>
        Returns:
        a copy of the keys of the map as an array.
      • keys

        public K[] keys​(K[] a)
        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 interface TObjectDoubleMap<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

        public TDoubleCollection valueCollection()
        Returns a TDoubleCollection 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 interface TObjectDoubleMap<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 interface TObjectDoubleMap<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 interface TObjectDoubleMap<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.
      • increment

        public boolean increment​(K key)
        Increments the primitive value mapped to key by 1
        Specified by:
        increment in interface TObjectDoubleMap<K>
        Parameters:
        key - the key of the value to increment
        Returns:
        true if a mapping was found and modified.
      • adjustValue

        public boolean adjustValue​(K key,
                                   double amount)
        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 interface TObjectDoubleMap<K>
        Parameters:
        key - the key of the value to increment
        amount - the amount to add to the value; may be positive, zero, or negative
        Returns:
        true if a mapping was found and modified
        See Also:
        TObjectDoubleMap.adjustOrPutValue(Object, double, double)
      • adjustOrPutValue

        public double 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. Otherwise, the put_amount is put in the map.
        Specified by:
        adjustOrPutValue in interface TObjectDoubleMap<K>
        Parameters:
        key - the key of the value to increment
        adjust_amount - the amount to add to the value; may be positive, zero, or negative
        put_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

        public boolean forEachKey​(TObjectProcedure<? super K> procedure)
        Executes procedure for each key in the map.
        Specified by:
        forEachKey in interface TObjectDoubleMap<K>
        Parameters:
        procedure - a TObjectProcedure 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 interface TObjectDoubleMap<K>
        Parameters:
        procedure - a TDoubleProcedure value
        Returns:
        false if the loop over the values terminated because the procedure returned false for some value.
      • forEachEntry

        public boolean forEachEntry​(TObjectDoubleProcedure<? super K> procedure)
        Executes procedure for each key/value entry in the map.
        Specified by:
        forEachEntry in interface TObjectDoubleMap<K>
        Parameters:
        procedure - a TOObjectDoubleProcedure value
        Returns:
        false if the loop over the entries terminated because the procedure returned false for some entry.
      • retainEntries

        public boolean retainEntries​(TObjectDoubleProcedure<? super K> procedure)
        Retains only those entries in the map for which the procedure returns a true value.
        Specified by:
        retainEntries in interface TObjectDoubleMap<K>
        Parameters:
        procedure - determines which entries to keep
        Returns:
        true if the map was modified.
      • transformValues

        public void transformValues​(TDoubleFunction function)
        Transform the values in this map using function.
        Specified by:
        transformValues in interface TObjectDoubleMap<K>
        Parameters:
        function - a TDoubleFunction value
      • equals

        public boolean equals​(java.lang.Object other)
        Compares this map with another map for equality of their stored entries.
        Specified by:
        equals in interface TObjectDoubleMap<K>
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - an Object 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 of Object.hashCode().
        Specified by:
        hashCode in interface TObjectDoubleMap<K>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code value for this map
        See Also:
        Object.equals(Object), TObjectDoubleMap.equals(Object)
      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                           throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Overrides:
        writeExternal in class TCustomObjectHash<K>
        Throws:
        java.io.IOException
      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Overrides:
        readExternal in class TCustomObjectHash<K>
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object