Package gnu.trove.map.hash

Class TCharIntHashMap

java.lang.Object
gnu.trove.impl.hash.THash
gnu.trove.impl.hash.TPrimitiveHash
gnu.trove.impl.hash.TCharIntHash
gnu.trove.map.hash.TCharIntHashMap
All Implemented Interfaces:
TCharIntMap, Externalizable, Serializable
public class TCharIntHashMap extends TCharIntHash implements TCharIntMap, Externalizable
An open addressed Map implementation for char keys and int values.
See Also:

  • Field Details

    • _values

      protected transient int[] _values
      the values of the map

  • Constructor Details

    • TCharIntHashMap

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

    • TCharIntHashMap

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

    • TCharIntHashMap

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

    • TCharIntHashMap

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

    • TCharIntHashMap

      public TCharIntHashMap(char[] keys, int[] values)
      Creates a new TCharIntHashMap instance containing all of the entries in the map passed in.
      Parameters:
      keys - a char array containing the keys for the matching values.
      values - a int array containing the values.

    • TCharIntHashMap

      public TCharIntHashMap(TCharIntMap map)
      Creates a new TCharIntHashMap instance containing all of the entries in the map passed in.
      Parameters:
      map - a TCharIntMap 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 TCharIntHash
      Parameters:
      initialCapacity - an int value
      Returns:
      the actual capacity chosen

    • rehash

      protected void rehash(int newCapacity)
      Rehashes the set.
      Specified by:
      rehash in class THash
      Parameters:
      newCapacity - an int value

    • put

      public int put(char key, int value)
      Inserts a key/value pair into the map.
      Specified by:
      put in interface TCharIntMap
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

    • putIfAbsent

      public int putIfAbsent(char key, int 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 TCharIntMap
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

    • putAll

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

    • putAll

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

    • get

      public int get(char key)
      Retrieves the value for key.
      Specified by:
      get in interface TCharIntMap
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

    • clear

      public void clear()
      Empties the collection.
      Specified by:
      clear in interface TCharIntMap
      Overrides:
      clear in class THash

    • isEmpty

      public boolean isEmpty()
      Tells whether this set is currently holding any elements.
      Specified by:
      isEmpty in interface TCharIntMap
      Overrides:
      isEmpty in class THash
      Returns:
      a boolean value

    • remove

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

    • removeAt

      protected void removeAt(int index)
      Releases the element currently stored at index.
      Overrides:
      removeAt in class TCharIntHash
      Parameters:
      index - an int value

    • keySet

      public TCharSet keySet()
      Returns the keys of the map as a TCharSet
      Specified by:
      keySet in interface TCharIntMap
      Returns:
      the keys of the map as a TCharSet

    • keys

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

    • keys

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

    • values

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

    • values

      public int[] values(int[] array)
      Returns the values of the map using an existing array.
      Specified by:
      values in interface TCharIntMap
      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(int val)
      Checks for the presence of val in the values of the map.
      Specified by:
      containsValue in interface TCharIntMap

    • containsKey

      public boolean containsKey(char key)
      Checks for the present of key in the keys of the map.
      Specified by:
      containsKey in interface TCharIntMap

    • iterator

      public TCharIntIterator iterator()
      Specified by:
      iterator in interface TCharIntMap
      Returns:
      a TCharIntIterator with access to this map's keys and values

    • forEachKey

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

    • forEachValue

      public boolean forEachValue(TIntProcedure procedure)
      Executes procedure for each value in the map.
      Specified by:
      forEachValue in interface TCharIntMap
      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(TCharIntProcedure procedure)
      Executes procedure for each key/value entry in the map.
      Specified by:
      forEachEntry in interface TCharIntMap
      Parameters:
      procedure - a TOCharIntProcedure value
      Returns:
      false if the loop over the entries terminated because the procedure returned false for some entry.

    • transformValues

      public void transformValues(TIntFunction function)
      Transform the values in this map using function.
      Specified by:
      transformValues in interface TCharIntMap
      Parameters:
      function - a TIntFunction value

    • retainEntries

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

    • increment

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

    • adjustValue

      public boolean adjustValue(char key, int amount)
      Adjusts the primitive value mapped to key.
      Specified by:
      adjustValue in interface TCharIntMap
      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 int adjustOrPutValue(char key, int adjust_amount, int 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.
      Specified by:
      adjustOrPutValue in interface TCharIntMap
      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

    • 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 TCharIntHash
      Throws:
      IOException

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Overrides:
      readExternal in class TCharIntHash
      Throws:
      IOException
      ClassNotFoundException