Package gnu.trove.map

Interface TObjectDoubleMap<K>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      boolean adjustValue​(K key, double amount)
      Adds an amount to the primitive value mapped to key.
      void clear()
      Removes all of the mappings from this map (optional operation).
      boolean containsKey​(java.lang.Object key)
      Checks for the present of key in the keys of the map.
      boolean containsValue​(double value)
      Checks for the presence of val in the values of the map.
      boolean equals​(java.lang.Object o)
      Compares the specified object with this map for equality.
      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 get​(java.lang.Object key)
      Retrieves the value for key.
      double getNoEntryValue()
      Returns the value that will be returned from get(java.lang.Object) or put(K, double) if no entry exists for a given key.
      int hashCode()
      Returns the hash code value for this map.
      boolean increment​(K key)
      Increments the primitive value mapped to key by 1
      boolean isEmpty()
      Returns true if this map contains no key-value mappings.
      TObjectDoubleIterator<K> iterator()
      Returns a TObjectDoubleIterator with access to this map's keys and values.
      java.lang.Object[] keys()
      Returns a copy of the keys of the map as an array.
      K[] keys​(K[] array)
      Returns a copy of the keys of the map as an array.
      java.util.Set<K> keySet()
      Returns a Set view of the keys contained in this map.
      double put​(K key, double value)
      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 putAll​(java.util.Map<? extends K,​? extends java.lang.Double> m)
      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.
      double remove​(java.lang.Object key)
      Deletes a key/value pair 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 size()
      Returns the number of key-value mappings in this map.
      void transformValues​(TDoubleFunction function)
      Transform the values in this map using function.
      TDoubleCollection valueCollection()
      Returns a TDoubleCollection 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.
    • Method Detail

      • getNoEntryValue

        double getNoEntryValue()
        Returns the value that will be returned from get(java.lang.Object) or 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.
        Returns:
        the value that represents a null value in this collection.
      • size

        int size()
        Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Returns:
        the number of key-value mappings in this map
      • isEmpty

        boolean isEmpty()
        Returns true if this map contains no key-value mappings.
        Returns:
        true if this map contains no key-value mappings
      • containsKey

        boolean containsKey​(java.lang.Object key)
        Checks for the present of key in the keys of the map.
      • containsValue

        boolean containsValue​(double value)
        Checks for the presence of val in the values of the map.
      • get

        double get​(java.lang.Object key)
        Retrieves the value for key.
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).
      • put

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

        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.
        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 getNoEntryValue()).
      • remove

        double remove​(java.lang.Object key)
        Deletes a key/value pair from the map.
        Parameters:
        key - an #k# value
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).
      • putAll

        void putAll​(java.util.Map<? extends K,​? extends java.lang.Double> m)
        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.
        Parameters:
        m - mappings to be stored in this map
        Throws:
        java.lang.UnsupportedOperationException - if the putAll operation is not supported by this map
        java.lang.ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map
        java.lang.NullPointerException - if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values
        java.lang.IllegalArgumentException - if some property of a key or value in the specified map prevents it from being stored in this map
      • putAll

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

        void clear()
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
        Throws:
        java.lang.UnsupportedOperationException - if the clear operation is not supported by this map
      • keySet

        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.
        Returns:
        a set view of the keys contained in this map
      • keys

        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.
        Returns:
        a copy of the keys of the map as an array.
      • keys

        K[] keys​(K[] array)
        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.
        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

        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.
        Returns:
        a collection view of the values contained in this map
      • values

        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.
        Returns:
        the values of the map as an array of double values.
      • values

        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.
        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

        TObjectDoubleIterator<K> iterator()
        Returns a TObjectDoubleIterator with access to this map's keys and values.
        Returns:
        a TObjectDoubleIterator with access to this map's keys and values.
      • increment

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

        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).
        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:
        adjustOrPutValue(Object, double, double)
      • adjustOrPutValue

        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.
        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

        boolean forEachKey​(TObjectProcedure<? super K> procedure)
        Executes procedure for each key in the map.
        Parameters:
        procedure - a TObjectProcedure value
        Returns:
        false if the loop over the keys terminated because the procedure returned false for some key.
      • forEachValue

        boolean forEachValue​(TDoubleProcedure procedure)
        Executes procedure for each value in the map.
        Parameters:
        procedure - a TDoubleProcedure value
        Returns:
        false if the loop over the values terminated because the procedure returned false for some value.
      • forEachEntry

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

        void transformValues​(TDoubleFunction function)
        Transform the values in this map using function.
        Parameters:
        function - a TDoubleFunction value
      • retainEntries

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

        boolean equals​(java.lang.Object o)
        Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - object to be compared for equality with this map
        Returns:
        true if the specified object is equal to this map
      • hashCode

        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().
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code value for this map
        See Also:
        Object.equals(Object), equals(Object)