Class Short2ByteOpenCustomHashMap

  • All Implemented Interfaces:
    Function<Short,​Byte>, Hash, Short2ByteFunction, Short2ByteMap, Serializable, Cloneable, Function<Short,​Byte>, IntUnaryOperator, Map<Short,​Byte>

    public class Short2ByteOpenCustomHashMap
    extends AbstractShort2ByteMap
    implements Serializable, Cloneable, Hash
    A type-specific hash map with a fast, small-footprint implementation whose hashing strategy is specified at creation time.

    Instances of this class use a hash table to represent a map. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.

    Note that clear() does not modify the hash table size. Rather, a family of trimming methods lets you control the size of the table; this is particularly useful if you reuse instances of this class.

    See Also:
    Hash, HashCommon, Serialized Form
    • Constructor Detail

      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(int expected,
                                           float f,
                                           ShortHash.Strategy strategy)
        Creates a new hash map.

        The actual table size will be the least power of two greater than expected/f.

        Parameters:
        expected - the expected number of elements in the hash map.
        f - the load factor.
        strategy - the strategy.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(int expected,
                                           ShortHash.Strategy strategy)
        Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.
        Parameters:
        expected - the expected number of elements in the hash map.
        strategy - the strategy.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(Map<? extends Short,​? extends Byte> m,
                                           float f,
                                           ShortHash.Strategy strategy)
        Creates a new hash map copying a given one.
        Parameters:
        m - a Map to be copied into the new hash map.
        f - the load factor.
        strategy - the strategy.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(Map<? extends Short,​? extends Byte> m,
                                           ShortHash.Strategy strategy)
        Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.
        Parameters:
        m - a Map to be copied into the new hash map.
        strategy - the strategy.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(Short2ByteMap m,
                                           float f,
                                           ShortHash.Strategy strategy)
        Creates a new hash map copying a given type-specific one.
        Parameters:
        m - a type-specific map to be copied into the new hash map.
        f - the load factor.
        strategy - the strategy.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(Short2ByteMap m,
                                           ShortHash.Strategy strategy)
        Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.
        Parameters:
        m - a type-specific map to be copied into the new hash map.
        strategy - the strategy.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(short[] k,
                                           byte[] v,
                                           float f,
                                           ShortHash.Strategy strategy)
        Creates a new hash map using the elements of two parallel arrays.
        Parameters:
        k - the array of keys of the new hash map.
        v - the array of corresponding values in the new hash map.
        f - the load factor.
        strategy - the strategy.
        Throws:
        IllegalArgumentException - if k and v have different lengths.
      • Short2ByteOpenCustomHashMap

        public Short2ByteOpenCustomHashMap​(short[] k,
                                           byte[] v,
                                           ShortHash.Strategy strategy)
        Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.
        Parameters:
        k - the array of keys of the new hash map.
        v - the array of corresponding values in the new hash map.
        strategy - the strategy.
        Throws:
        IllegalArgumentException - if k and v have different lengths.
    • Method Detail

      • strategy

        public ShortHash.Strategy strategy()
        Returns the hashing strategy.
        Returns:
        the hashing strategy of this custom hash map.
      • addTo

        public byte addTo​(short k,
                          byte incr)
        Adds an increment to value currently associated with a key.

        Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.

        Parameters:
        k - the key.
        incr - the increment.
        Returns:
        the old value, or the default return value if no value was present for the given key.
      • getOrDefault

        public byte getOrDefault​(short k,
                                 byte defaultValue)
        Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
        Specified by:
        getOrDefault in interface Short2ByteMap
        Parameters:
        k - the key.
        defaultValue - the default mapping of the key.
        Returns:
        the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
        See Also:
        Map.getOrDefault(Object, Object)
      • putIfAbsent

        public byte putIfAbsent​(short k,
                                byte v)
        If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.
        Specified by:
        putIfAbsent in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is to be associated.
        v - value to be associated with the specified key.
        Returns:
        the previous value associated with the specified key, or the default return value if there was no mapping for the key.
        See Also:
        Map.putIfAbsent(Object, Object)
      • remove

        public boolean remove​(short k,
                              byte v)
        Removes the entry for the specified key only if it is currently mapped to the specified value.
        Specified by:
        remove in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is associated.
        v - value expected to be associated with the specified key.
        Returns:
        true if the value was removed.
        See Also:
        Map.remove(Object, Object)
      • replace

        public boolean replace​(short k,
                               byte oldValue,
                               byte v)
        Replaces the entry for the specified key only if currently mapped to the specified value.
        Specified by:
        replace in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is associated.
        oldValue - value expected to be associated with the specified key.
        v - value to be associated with the specified key.
        Returns:
        true if the value was replaced.
        See Also:
        Map.replace(Object, Object, Object)
      • replace

        public byte replace​(short k,
                            byte v)
        Replaces the entry for the specified key only if it is currently mapped to some value.
        Specified by:
        replace in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is associated.
        v - value to be associated with the specified key.
        Returns:
        the previous value associated with the specified key, or the default return value if there was no mapping for the key.
        See Also:
        Map.replace(Object, Object)
      • computeIfAbsent

        public byte computeIfAbsent​(short k,
                                    IntUnaryOperator mappingFunction)
        If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.

        Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the mappingFunction cannot return null. If such a behavior is needed, please use the corresponding nullable version.

        Specified by:
        computeIfAbsent in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is to be associated.
        mappingFunction - the function to compute a value.
        Returns:
        the current (existing or computed) value associated with the specified key.
        See Also:
        Map.computeIfAbsent(Object, java.util.function.Function)
      • computeIfAbsentNullable

        public byte computeIfAbsentNullable​(short k,
                                            IntFunction<? extends Byte> mappingFunction)
        If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map unless it is null.

        Note that this version of computeIfAbsent() should be used only if you plan to return null in the mapping function.

        Specified by:
        computeIfAbsentNullable in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is to be associated.
        mappingFunction - the function to compute a value.
        Returns:
        the current (existing or computed) value associated with the specified key, or the default return value if the computed value is null.
        See Also:
        Map.computeIfAbsent(Object, java.util.function.Function)
      • compute

        public byte compute​(short k,
                            BiFunction<? super Short,​? super Byte,​? extends Byte> remappingFunction)
        Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).

        If the function returns null, the mapping is removed (or remains absent if initially absent). If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

        Specified by:
        compute in interface Short2ByteMap
        Parameters:
        k - key with which the specified value is to be associated.
        remappingFunction - the function to compute a value.
        Returns:
        the new value associated with the specified key, or the default return value if none.
        See Also:
        Map.compute(Object, java.util.function.BiFunction)
      • merge

        public byte merge​(short k,
                          byte v,
                          BiFunction<? super Byte,​? super Byte,​? extends Byte> remappingFunction)
        If the specified key is not already associated with a value, associates it with the given value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.
        Specified by:
        merge in interface Short2ByteMap
        Parameters:
        k - key with which the resulting value is to be associated.
        v - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.
        remappingFunction - the function to recompute a value if present.
        Returns:
        the new value associated with the specified key, or the default return value if no value is associated with the key.
        See Also:
        Map.merge(Object, Object, java.util.function.BiFunction)
      • short2ByteEntrySet

        public Short2ByteMap.FastEntrySet short2ByteEntrySet()
        Description copied from interface: Short2ByteMap
        Returns a type-specific set view of the mappings contained in this map.

        This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Map.entrySet() so that it returns an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).

        Specified by:
        short2ByteEntrySet in interface Short2ByteMap
        Returns:
        a type-specific set view of the mappings contained in this map.
        See Also:
        Map.entrySet()
      • keySet

        public ShortSet keySet()
        Description copied from class: AbstractShort2ByteMap
        Returns a type-specific-set view of the keys of this map.

        The view is backed by the set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

        Specified by:
        keySet in interface Map<Short,​Byte>
        Specified by:
        keySet in interface Short2ByteMap
        Overrides:
        keySet in class AbstractShort2ByteMap
        Returns:
        a set view of the keys of this map; it may be safely cast to a type-specific interface.
        See Also:
        Map.keySet()
      • values

        public ByteCollection values()
        Description copied from class: AbstractShort2ByteMap
        Returns a type-specific-set view of the values of this map.

        The view is backed by the set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

        Specified by:
        values in interface Map<Short,​Byte>
        Specified by:
        values in interface Short2ByteMap
        Overrides:
        values in class AbstractShort2ByteMap
        Returns:
        a set view of the values of this map; it may be safely cast to a type-specific interface.
        See Also:
        Map.values()
      • trim

        public boolean trim()
        Rehashes the map, making the table as small as possible.

        This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.

        If the table size is already the minimum possible, this method does nothing.

        Returns:
        true if there was enough memory to trim the map.
        See Also:
        trim(int)
      • trim

        public boolean trim​(int n)
        Rehashes this map if the table is too large.

        Let N be the smallest table size that can hold max(n,size()) entries, still satisfying the load factor. If the current table size is smaller than or equal to N, this method does nothing. Otherwise, it rehashes this map in a table of size N.

        This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.

        Parameters:
        n - the threshold for the trimming.
        Returns:
        true if there was enough memory to trim the map.
        See Also:
        trim()
      • clone

        public Short2ByteOpenCustomHashMap clone()
        Returns a deep copy of this map.

        This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.

        Returns:
        a deep copy of this map.
      • hashCode

        public int hashCode()
        Returns a hash code for this map. This method overrides the generic method provided by the superclass. Since equals() is not overriden, it is important that the value returned by this method is the same value as the one returned by the overriden method.
        Specified by:
        hashCode in interface Map<Short,​Byte>
        Overrides:
        hashCode in class AbstractShort2ByteMap
        Returns:
        a hash code for this map.