Package gnu.trove.map.hash

Class TCharShortHashMap

  • All Implemented Interfaces:
    TCharShortMap, java.io.Externalizable, java.io.Serializable
    public class TCharShortHashMap
extends TCharShortHash
implements TCharShortMap, java.io.Externalizable
    An open addressed Map implementation for char keys and short values.
    See Also:
    Serialized Form

    • Field Detail

      • _values

        protected transient short[] _values
        the values of the map

    • Constructor Detail

      • TCharShortHashMap

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

      • TCharShortHashMap

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

      • TCharShortHashMap

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

      • TCharShortHashMap

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

      • TCharShortHashMap

        public TCharShortHashMap​(char[] keys,
                         short[] values)
        Creates a new TCharShortHashMap 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 short array containing the values.

      • TCharShortHashMap

        public TCharShortHashMap​(TCharShortMap map)
        Creates a new TCharShortHashMap instance containing all of the entries in the map passed in.
        Parameters:
        map - a TCharShortMap that will be duplicated.

    • Method Detail

      • setUp

        protected int setUp​(int initialCapacity)
        initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
        Overrides:
        setUp in class TCharShortHash
        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 short put​(char key,
                 short value)
        Inserts a key/value pair into the map.
        Specified by:
        put in interface TCharShortMap
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TCharShortMap.getNoEntryValue()).

      • putIfAbsent

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

      • putAll

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

      • putAll

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

      • get

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

      • isEmpty

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

      • remove

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

      • removeAt

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

      • keySet

        public TCharSet keySet()
        Returns the keys of the map as a TCharSet
        Specified by:
        keySet in interface TCharShortMap
        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 TCharShortMap
        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 TCharShortMap
        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 TCharShortMap
        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 TCharShortMap
        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 TCharShortMap
        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 TCharShortMap

      • containsKey

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

      • forEachKey

        public boolean forEachKey​(TCharProcedure procedure)
        Executes procedure for each key in the map.
        Specified by:
        forEachKey in interface TCharShortMap
        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​(TShortProcedure procedure)
        Executes procedure for each value in the map.
        Specified by:
        forEachValue in interface TCharShortMap
        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​(TCharShortProcedure procedure)
        Executes procedure for each key/value entry in the map.
        Specified by:
        forEachEntry in interface TCharShortMap
        Parameters:
        procedure - a TOCharShortProcedure 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 TCharShortMap
        Parameters:
        function - a TShortFunction value

      • retainEntries

        public boolean retainEntries​(TCharShortProcedure procedure)
        Retains only those entries in the map for which the procedure returns a true value.
        Specified by:
        retainEntries in interface TCharShortMap
        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 TCharShortMap
        Parameters:
        key - the key of the value to increment
        Returns:
        true if a mapping was found and modified.

      • adjustValue

        public boolean adjustValue​(char key,
                           short amount)
        Adjusts the primitive value mapped to key.
        Specified by:
        adjustValue in interface TCharShortMap
        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​(char 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 put_amount is put in the map.
        Specified by:
        adjustOrPutValue in interface TCharShortMap
        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​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

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

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                   throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Overrides:
        writeExternal in class TCharShortHash
        Throws:
        java.io.IOException

      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Overrides:
        readExternal in class TCharShortHash
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException