Package gnu.trove.map

Interface TShortDoubleMap

All Known Implementing Classes:
TShortDoubleHashMap, TSynchronizedShortDoubleMap, TUnmodifiableShortDoubleMap
public interface TShortDoubleMap
Interface for a primitive map of short keys and double values.

  • Method Summary

    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 map.
    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
    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 key.
    short
    getNoEntryKey()
    Returns the value that will be returned from get(short) or put(short, double) if no entry exists for a given key.
    double
    getNoEntryValue()
    Returns the value that will be returned from get(short) or put(short, double) if no entry exists for a given key.
    boolean
    increment(short key)
    Increments the primitive value mapped to key by 1
    boolean
    isEmpty()
    Returns true if this map contains no key-value mappings.
    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 TShortSet
    double
    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(Map<? extends Short,? extends 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.
    double
    remove(short key)
    Deletes a key/value pair from the map.
    boolean
    retainEntries(TShortDoubleProcedure procedure)
    Retains only those entries in the map for which the procedure returns a true value.
    int
    size()
    Returns an int value that is the number of elements in the map.
    void
    transformValues(TDoubleFunction function)
    Transform the values in this map using function.
    TDoubleCollection
    valueCollection()
    Returns the values of the map as a TDoubleCollection
    double[]
    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.

  • Method Details

    • getNoEntryKey

      short getNoEntryKey()
      Returns the value that will be returned from get(short) or put(short, 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 key in this collection.

    • getNoEntryValue

      double getNoEntryValue()
      Returns the value that will be returned from get(short) or put(short, 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.

    • put

      double put(short 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(short key, double value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • putAll

      void putAll(Map<? extends Short,? extends Double> 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.

    • putAll

      void putAll(TShortDoubleMap 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.

    • get

      double get(short key)
      Retrieves the value for key.
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • clear

      void clear()
      Empties the map.

    • isEmpty

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

    • remove

      double remove(short key)
      Deletes a key/value pair from the map.
      Parameters:
      key - an short value
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • size

      int size()
      Returns an int value that is the number of elements in the map.
      Returns:
      an int value that is the number of elements in the map.

    • keySet

      TShortSet keySet()
      Returns the keys of the map as a TShortSet
      Returns:
      the keys of the map as a TShortSet

    • keys

      short[] keys()
      Returns the keys of the map as an array of short values.
      Returns:
      the keys of the map as an array of short values.

    • keys

      short[] keys(short[] array)
      Returns the keys of the map.
      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 the values of the map as a TDoubleCollection
      Returns:
      the values of the map as a TDoubleCollection

    • values

      double[] values()
      Returns the values of the map as an array of #e# values.
      Returns:
      the values of the map as an array of #e# values.

    • values

      double[] values(double[] array)
      Returns the values of the map using an existing array.
      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

      boolean containsValue(double val)
      Checks for the presence of val in the values of the map.

    • containsKey

      boolean containsKey(short key)
      Checks for the present of key in the keys of the map.

    • iterator

      TShortDoubleIterator iterator()
      Returns:
      a TShortDoubleIterator with access to this map's keys and values

    • forEachKey

      boolean forEachKey(TShortProcedure procedure)
      Executes procedure for each key in the map.
      Parameters:
      procedure - a TShortProcedure 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 T#F#Procedure value
      Returns:
      false if the loop over the values terminated because the procedure returned false for some value.

    • forEachEntry

      boolean forEachEntry(TShortDoubleProcedure procedure)
      Executes procedure for each key/value entry in the map.
      Parameters:
      procedure - a TOShortDoubleProcedure 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(TShortDoubleProcedure 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.

    • increment

      boolean increment(short 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(short key, double amount)
      Adjusts the primitive value mapped to key.
      Parameters:
      key - the key of the value to increment
      amount - the amount to adjust the value by.
      Returns:
      true if a mapping was found and modified.

    • adjustOrPutValue

      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 put_amount is put in the map.
      Parameters:
      key - the key of the value to increment
      adjust_amount - the amount to adjust the value by
      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