Package gnu.trove.impl.unmodifiable

Class TUnmodifiableObjectDoubleMap<K>

    • Method Summary

      All Methods Instance Methods Concrete 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 val)
      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 TObjectDoubleMap.get(java.lang.Object) or TObjectDoubleMap.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> m)
      Put all the entries from the given map into this map.
      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).
      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.
      java.lang.String toString()  
      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.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • TUnmodifiableObjectDoubleMap

        public TUnmodifiableObjectDoubleMap​(TObjectDoubleMap<K> m)

    • Method Detail

      • size

        public int size()
        Description copied from interface: TObjectDoubleMap
        Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface TObjectDoubleMap<K>
        Returns:
        the number of key-value mappings in this map

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: TObjectDoubleMap
        Returns true if this map contains no key-value mappings.
        Specified by:
        isEmpty in interface TObjectDoubleMap<K>
        Returns:
        true if this map contains no key-value mappings

      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Description copied from interface: TObjectDoubleMap
        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)
        Description copied from interface: TObjectDoubleMap
        Checks for the presence of val in the values of the map.
        Specified by:
        containsValue in interface TObjectDoubleMap<K>

      • remove

        public double remove​(java.lang.Object key)
        Description copied from interface: TObjectDoubleMap
        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()).

      • putAll

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

      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends java.lang.Double> map)
        Description copied from interface: TObjectDoubleMap
        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

      • clear

        public void clear()
        Description copied from interface: TObjectDoubleMap
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
        Specified by:
        clear in interface TObjectDoubleMap<K>

      • keySet

        public java.util.Set<K> keySet()
        Description copied from interface: TObjectDoubleMap
        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()
        Description copied from interface: TObjectDoubleMap
        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[] array)
        Description copied from interface: TObjectDoubleMap
        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:
        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()
        Description copied from interface: TObjectDoubleMap
        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()
        Description copied from interface: TObjectDoubleMap
        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)
        Description copied from interface: TObjectDoubleMap
        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.

      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from interface: TObjectDoubleMap
        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.
        Specified by:
        equals in interface TObjectDoubleMap<K>
        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

        public int hashCode()
        Description copied from interface: TObjectDoubleMap
        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)

      • toString

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

      • forEachKey

        public boolean forEachKey​(TObjectProcedure<? super K> procedure)
        Description copied from interface: TObjectDoubleMap
        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)
        Description copied from interface: TObjectDoubleMap
        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)
        Description copied from interface: TObjectDoubleMap
        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.

      • iterator

        public TObjectDoubleIterator<K> iterator()
        Description copied from interface: TObjectDoubleMap
        Returns a TObjectDoubleIterator with access to this map's keys and values.
        Specified by:
        iterator in interface TObjectDoubleMap<K>
        Returns:
        a TObjectDoubleIterator with access to this map's keys and values.

      • putIfAbsent

        public double putIfAbsent​(K key,
                          double value)
        Description copied from interface: TObjectDoubleMap
        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()).

      • retainEntries

        public boolean retainEntries​(TObjectDoubleProcedure<? super K> procedure)
        Description copied from interface: TObjectDoubleMap
        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.

      • increment

        public boolean increment​(K key)
        Description copied from interface: TObjectDoubleMap
        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)
        Description copied from interface: TObjectDoubleMap
        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)
        Description copied from interface: TObjectDoubleMap
        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