Class TLongShortHashMap

java.lang.Object
gnu.trove.impl.hash.THash
gnu.trove.impl.hash.TPrimitiveHash
gnu.trove.impl.hash.TLongShortHash
gnu.trove.map.hash.TLongShortHashMap
All Implemented Interfaces:
TLongShortMap, Externalizable, Serializable

public class TLongShortHashMap extends gnu.trove.impl.hash.TLongShortHash implements TLongShortMap, Externalizable
An open addressed Map implementation for long keys and short values.
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected class 
    a view onto the keys of the map.
    protected class 
    a view onto the values of the map.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected short[]
    the values of the map

    Fields inherited from class gnu.trove.impl.hash.TLongShortHash

    _set, consumeFreeSlot, no_entry_key, no_entry_value

    Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash

    _states, FREE, FULL, REMOVED

    Fields inherited from class gnu.trove.impl.hash.THash

    _autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new TLongShortHashMap instance with the default capacity and load factor.
    TLongShortHashMap(int initialCapacity)
    Creates a new TLongShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    TLongShortHashMap(int initialCapacity, float loadFactor)
    Creates a new TLongShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
    TLongShortHashMap(int initialCapacity, float loadFactor, long noEntryKey, short noEntryValue)
    Creates a new TLongShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
    TLongShortHashMap(long[] keys, short[] values)
    Creates a new TLongShortHashMap instance containing all of the entries in the map passed in.
    Creates a new TLongShortHashMap instance containing all of the entries in the map passed in.
  • Method Summary

    Modifier and Type
    Method
    Description
    short
    adjustOrPutValue(long key, short adjust_amount, short put_amount)
    Adjusts the primitive value mapped to the key if the key is present in the map.
    boolean
    adjustValue(long key, short amount)
    Adjusts the primitive value mapped to key.
    void
    Empties the collection.
    boolean
    containsKey(long key)
    Checks for the present of key in the keys of the map.
    boolean
    containsValue(short val)
    Checks for the presence of val in the values of the map.
    boolean
    equals(Object other)
    boolean
    Executes procedure for each key/value entry in the map.
    boolean
    Executes procedure for each key in the map.
    boolean
    Executes procedure for each value in the map.
    short
    get(long key)
    Retrieves the value for key
    int
    boolean
    increment(long key)
    Increments the primitive value mapped to key by 1
    boolean
    Tells whether this set is currently holding any elements.
    long[]
    Returns the keys of the map as an array of long values.
    long[]
    keys(long[] array)
    Returns the keys of the map.
    Returns the keys of the map as a TLongSet
    short
    put(long key, short value)
    Inserts a key/value pair into the map.
    void
    Put all the entries from the given map into this map.
    void
    putAll(Map<? extends Long,? extends Short> map)
    Put all the entries from the given Map into this map.
    short
    putIfAbsent(long key, short 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 set.
    short
    remove(long key)
    Deletes a key/value pair from the map.
    protected void
    removeAt(int index)
    Releases the element currently stored at index.
    boolean
    Retains only those entries in the map for which the procedure returns a true value.
    protected int
    setUp(int initialCapacity)
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    void
    Transform the values in this map using function.
    Returns the values of the map as a TShortCollection
    short[]
    Returns the values of the map as an array of #e# values.
    short[]
    values(short[] array)
    Returns the values of the map using an existing array.
    void

    Methods inherited from class gnu.trove.impl.hash.TLongShortHash

    contains, forEach, getNoEntryKey, getNoEntryValue, index, insertKey, XinsertKey

    Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash

    capacity

    Methods inherited from class gnu.trove.impl.hash.THash

    calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, 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.TLongShortMap

    getNoEntryKey, getNoEntryValue, size
  • Field Details

    • _values

      protected transient short[] _values
      the values of the map
  • Constructor Details

    • TLongShortHashMap

      public TLongShortHashMap()
      Creates a new TLongShortHashMap instance with the default capacity and load factor.
    • TLongShortHashMap

      public TLongShortHashMap(int initialCapacity)
      Creates a new TLongShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
      Parameters:
      initialCapacity - an int value
    • TLongShortHashMap

      public TLongShortHashMap(int initialCapacity, float loadFactor)
      Creates a new TLongShortHashMap 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
    • TLongShortHashMap

      public TLongShortHashMap(int initialCapacity, float loadFactor, long noEntryKey, short noEntryValue)
      Creates a new TLongShortHashMap 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
      noEntryKey - a long value that represents null for the Key set.
      noEntryValue - a short value that represents null for the Value set.
    • TLongShortHashMap

      public TLongShortHashMap(long[] keys, short[] values)
      Creates a new TLongShortHashMap instance containing all of the entries in the map passed in.
      Parameters:
      keys - a long array containing the keys for the matching values.
      values - a short array containing the values.
    • TLongShortHashMap

      public TLongShortHashMap(TLongShortMap map)
      Creates a new TLongShortHashMap instance containing all of the entries in the map passed in.
      Parameters:
      map - a TLongShortMap that will be duplicated.
  • Method Details

    • setUp

      protected int setUp(int initialCapacity)
      initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
      Overrides:
      setUp in class gnu.trove.impl.hash.TLongShortHash
      Parameters:
      initialCapacity - an int value
      Returns:
      the actual capacity chosen
    • rehash

      protected void rehash(int newCapacity)
      Rehashes the set.
      Specified by:
      rehash in class gnu.trove.impl.hash.THash
      Parameters:
      newCapacity - an int value
    • put

      public short put(long key, short value)
      Inserts a key/value pair into the map.
      Specified by:
      put in interface TLongShortMap
      Parameters:
      key - an long value
      value - an short value
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TLongShortMap.getNoEntryValue()).
    • putIfAbsent

      public short putIfAbsent(long key, short 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 TLongShortMap
      Parameters:
      key - an long value
      value - an short value
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TLongShortMap.getNoEntryValue()).
    • putAll

      public void putAll(Map<? extends Long,? extends Short> map)
      Put all the entries from the given Map into this map.
      Specified by:
      putAll in interface TLongShortMap
      Parameters:
      map - The Map from which entries will be obtained to put into this map.
    • putAll

      public void putAll(TLongShortMap map)
      Put all the entries from the given map into this map.
      Specified by:
      putAll in interface TLongShortMap
      Parameters:
      map - The map from which entries will be obtained to put into this map.
    • get

      public short get(long key)
      Retrieves the value for key
      Specified by:
      get in interface TLongShortMap
      Parameters:
      key - an long value
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TLongShortMap.getNoEntryValue()).
    • clear

      public void clear()
      Empties the collection.
      Specified by:
      clear in interface TLongShortMap
      Overrides:
      clear in class gnu.trove.impl.hash.THash
    • isEmpty

      public boolean isEmpty()
      Tells whether this set is currently holding any elements.
      Specified by:
      isEmpty in interface TLongShortMap
      Overrides:
      isEmpty in class gnu.trove.impl.hash.THash
      Returns:
      a boolean value
    • remove

      public short remove(long key)
      Deletes a key/value pair from the map.
      Specified by:
      remove in interface TLongShortMap
      Parameters:
      key - an long value
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TLongShortMap.getNoEntryValue()).
    • removeAt

      protected void removeAt(int index)
      Releases the element currently stored at index.
      Overrides:
      removeAt in class gnu.trove.impl.hash.TLongShortHash
      Parameters:
      index - an int value
    • keySet

      public TLongSet keySet()
      Returns the keys of the map as a TLongSet
      Specified by:
      keySet in interface TLongShortMap
      Returns:
      the keys of the map as a TLongSet
    • keys

      public long[] keys()
      Returns the keys of the map as an array of long values.
      Specified by:
      keys in interface TLongShortMap
      Returns:
      the keys of the map as an array of long values.
    • keys

      public long[] keys(long[] array)
      Returns the keys of the map.
      Specified by:
      keys in interface TLongShortMap
      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 TShortCollection valueCollection()
      Returns the values of the map as a TShortCollection
      Specified by:
      valueCollection in interface TLongShortMap
      Returns:
      the values of the map as a TShortCollection
    • values

      public short[] values()
      Returns the values of the map as an array of #e# values.
      Specified by:
      values in interface TLongShortMap
      Returns:
      the values of the map as an array of #e# values.
    • values

      public short[] values(short[] array)
      Returns the values of the map using an existing array.
      Specified by:
      values in interface TLongShortMap
      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

      public boolean containsValue(short val)
      Checks for the presence of val in the values of the map.
      Specified by:
      containsValue in interface TLongShortMap
      Parameters:
      val - an short value
      Returns:
      a boolean value
    • containsKey

      public boolean containsKey(long key)
      Checks for the present of key in the keys of the map.
      Specified by:
      containsKey in interface TLongShortMap
      Parameters:
      key - an long value
      Returns:
      a boolean value
    • iterator

      public TLongShortIterator iterator()
      Specified by:
      iterator in interface TLongShortMap
      Returns:
      a TLongShortIterator with access to this map's keys and values
    • forEachKey

      public boolean forEachKey(TLongProcedure procedure)
      Executes procedure for each key in the map.
      Specified by:
      forEachKey in interface TLongShortMap
      Parameters:
      procedure - a TLongProcedure value
      Returns:
      false if the loop over the keys terminated because the procedure returned false for some key.
    • forEachValue

      public boolean forEachValue(TShortProcedure procedure)
      Executes procedure for each value in the map.
      Specified by:
      forEachValue in interface TLongShortMap
      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

      public boolean forEachEntry(TLongShortProcedure procedure)
      Executes procedure for each key/value entry in the map.
      Specified by:
      forEachEntry in interface TLongShortMap
      Parameters:
      procedure - a TOLongShortProcedure value
      Returns:
      false if the loop over the entries terminated because the procedure returned false for some entry.
    • transformValues

      public void transformValues(TShortFunction function)
      Transform the values in this map using function.
      Specified by:
      transformValues in interface TLongShortMap
      Parameters:
      function - a TShortFunction value
    • retainEntries

      public boolean retainEntries(TLongShortProcedure procedure)
      Retains only those entries in the map for which the procedure returns a true value.
      Specified by:
      retainEntries in interface TLongShortMap
      Parameters:
      procedure - determines which entries to keep
      Returns:
      true if the map was modified.
    • increment

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

      public boolean adjustValue(long key, short amount)
      Adjusts the primitive value mapped to key.
      Specified by:
      adjustValue in interface TLongShortMap
      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

      public short adjustOrPutValue(long key, short adjust_amount, short put_amount)
      Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.
      Specified by:
      adjustOrPutValue in interface TLongShortMap
      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 initial present
      Returns:
      the value present in the map after the adjustment or put operation
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Overrides:
      writeExternal in class gnu.trove.impl.hash.TLongShortHash
      Throws:
      IOException
    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Overrides:
      readExternal in class gnu.trove.impl.hash.TLongShortHash
      Throws:
      IOException
      ClassNotFoundException