Documentation of 'com.carrotsearch.hppc.ObjectShortHashMap' Java class
ObjectShortHashMap
Skip navigation links
com.carrotsearch.hppc

Class ObjectShortHashMap<KType>

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      java.lang.Object[] keys
      The array holding keys.
      short[] values
      The array holding values.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      short addTo(KType key, short incrementValue)
      Adds incrementValue to any existing value for the given key or inserts incrementValue if key did not previously exist.
      void clear()
      Clear all keys and values in the container.
      ObjectShortHashMap<KType> clone()
      boolean containsKey(KType key)
      Returns true if this container has an association to a value for the given key.
      void ensureCapacity(int expectedElements)
      Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.
      boolean equals(java.lang.Object obj)
      Compares the specified object with this set for equality.
      <T extends ObjectShortPredicate<? super KType>>
      T      		 forEach(T predicate)
      Applies a given predicate to all keys-value pairs in this container.
      <T extends ObjectShortProcedure<? super KType>>
      T      		 forEach(T procedure)
      Applies a given procedure to all keys-value pairs in this container.
      static <KType> ObjectShortHashMap<KType> from(KType[] keys, short[] values)
      Creates a hash map from two index-aligned arrays of key-value pairs.
      short get(KType key)
      short getOrDefault(KType key, short defaultValue)
      int hashCode()
      boolean indexExists(int index)
      short indexGet(int index)
      Returns the value associated with an existing key.
      void indexInsert(int index, KType key, short value)
      Inserts a key-value pair for a key that is not present in the map.
      int indexOf(KType key)
      Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic).
      short indexReplace(int index, short newValue)
      Replaces the value associated with an existing key and returns any previous value stored for that key.
      boolean isEmpty()
      java.util.Iterator<ObjectShortCursor<KType>> iterator()
      Returns a cursor over the entries (key-value pairs) in this map.
      ObjectShortHashMap.KeysContainer keys()
      Returns a specialized view of the keys of this associated container.
      short put(KType key, short value)
      Place a given key and value in the container.
      int putAll(java.lang.Iterable<? extends ObjectShortCursor<? extends KType>> iterable)
      Puts all key/value pairs from a given iterable into this map.
      int putAll(ObjectShortAssociativeContainer<? extends KType> container)
      Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
      boolean putIfAbsent(KType key, short value)
      Trove-inspired API method.
      short putOrAdd(KType key, short putValue, short incrementValue)
      If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.
      void release()
      Removes all elements from the collection and additionally releases any internal buffers.
      short remove(KType key)
      Remove all values at the given key.
      int removeAll(ObjectContainer<? super KType> other)
      Removes all keys (and associated values) present in a given container.
      int removeAll(ObjectPredicate<? super KType> predicate)
      Removes all keys (and associated values) for which the predicate returns true.
      int removeAll(ObjectShortPredicate<? super KType> predicate)
      Removes all keys (and associated values) for which the predicate returns true.
      int size()
      java.lang.String toString()
      Convert the contents of this map to a human-friendly string.
      ShortCollection values()
      Returns a container view of all values present in this container.
      java.lang.String visualizeKeyDistribution(int characters)
      Visually depict the distribution of keys.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Field Detail

      • keys

        public java.lang.Object[] keys
        The array holding keys.

      • values

        public short[] values
        The array holding values.

    • Constructor Detail

      • ObjectShortHashMap

        public ObjectShortHashMap()
        New instance with sane defaults.

      • ObjectShortHashMap

        public ObjectShortHashMap(int expectedElements)
        New instance with sane defaults.
        Parameters:
        expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).

      • ObjectShortHashMap

        public ObjectShortHashMap(int expectedElements,
                          double loadFactor)
        New instance with sane defaults.
        Parameters:
        expectedElements - The expected number of elements guaranteed not to cause buffer expansion (inclusive).
        loadFactor - The load factor for internal buffers. Insane load factors (zero, full capacity) are rejected by verifyLoadFactor(double).

      • ObjectShortHashMap

        public ObjectShortHashMap(int expectedElements,
                          double loadFactor,
                          HashOrderMixingStrategy orderMixer)
        New instance with the provided defaults.
        Parameters:
        expectedElements - The expected number of elements guaranteed not to cause a rehash (inclusive).
        loadFactor - The load factor for internal buffers. Insane load factors (zero, full capacity) are rejected by verifyLoadFactor(double).
        orderMixer - Hash key order mixing strategy. See HashOrderMixing for predefined implementations. Use constant mixers only if you understand the potential consequences.

    • Method Detail

      • put

        public short put(KType key,
                 short value)
        Place a given key and value in the container.
        Specified by:
        put in interface ObjectShortMap<KType>
        Returns:
        The value previously stored under the given key in the map is returned.

      • putAll

        public int putAll(ObjectShortAssociativeContainer<? extends KType> container)
        Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
        Specified by:
        putAll in interface ObjectShortMap<KType>
        Returns:
        Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.

      • putAll

        public int putAll(java.lang.Iterable<? extends ObjectShortCursor<? extends KType>> iterable)
        Puts all key/value pairs from a given iterable into this map.
        Specified by:
        putAll in interface ObjectShortMap<KType>
        Returns:
        Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.

      • putIfAbsent

        public boolean putIfAbsent(KType key,
                           short value)
        Trove-inspired API method. An equivalent of the following code: 
         if (!map.containsKey(key)) map.put(value);
        Parameters:
        key - The key of the value to check.
        value - The value to put if key does not exist.
        Returns:
        true if key did not exist and value was placed in the map.

      • putOrAdd

        public short putOrAdd(KType key,
                      short putValue,
                      short incrementValue)
        If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.
        Specified by:
        putOrAdd in interface ObjectShortMap<KType>
        Parameters:
        key - The key of the value to adjust.
        putValue - The value to put if key does not exist.
        incrementValue - The value to add to the existing value if key exists.
        Returns:
        Returns the current value associated with key (after changes).

      • addTo

        public short addTo(KType key,
                   short incrementValue)
        Adds incrementValue to any existing value for the given key or inserts incrementValue if key did not previously exist.
        Specified by:
        addTo in interface ObjectShortMap<KType>
        Parameters:
        key - The key of the value to adjust.
        incrementValue - The value to put or add to the existing value if key exists.
        Returns:
        Returns the current value associated with key (after changes).

      • remove

        public short remove(KType key)
        Remove all values at the given key. The default value for the key type is returned if the value does not exist in the map.
        Specified by:
        remove in interface ObjectShortMap<KType>

      • removeAll

        public int removeAll(ObjectContainer<? super KType> other)
        Removes all keys (and associated values) present in a given container. An alias to: 
         keys().removeAll(container)
        but with no additional overhead.
        Specified by:
        removeAll in interface ObjectShortAssociativeContainer<KType>
        Returns:
        Returns the number of elements actually removed as a result of this call.

      • get

        public short get(KType key)
        Specified by:
        get in interface ObjectShortMap<KType>
        Returns:
        Returns the value associated with the given key or the default value for the key type, if the key is not associated with any value. Important note: For primitive type values, the value returned for a non-existing key may not be the default value of the primitive type (it may be any value previously assigned to that slot).

      • getOrDefault

        public short getOrDefault(KType key,
                          short defaultValue)
        Specified by:
        getOrDefault in interface ObjectShortMap<KType>
        Returns:
        Returns the value associated with the given key or the provided default value if the key is not associated with any value.

      • indexExists

        public boolean indexExists(int index)
        Specified by:
        indexExists in interface ObjectShortMap<KType>
        Parameters:
        index - The index of a given key, as returned from ObjectShortMap.indexOf(KType).
        Returns:
        Returns true if the index corresponds to an existing key or false otherwise. This is equivalent to checking whether the index is a positive value (existing keys) or a negative value (non-existing keys).
        See Also:
        ObjectShortMap.indexOf(KType)

      • indexGet

        public short indexGet(int index)
        Returns the value associated with an existing key.
        Specified by:
        indexGet in interface ObjectShortMap<KType>
        Parameters:
        index - The index of an existing key.
        Returns:
        Returns the value currently associated with the key.
        See Also:
        ObjectShortMap.indexOf(KType)

      • indexReplace

        public short indexReplace(int index,
                          short newValue)
        Replaces the value associated with an existing key and returns any previous value stored for that key.
        Specified by:
        indexReplace in interface ObjectShortMap<KType>
        Parameters:
        index - The index of an existing key.
        Returns:
        Returns the previous value associated with the key.
        See Also:
        ObjectShortMap.indexOf(KType)

      • release

        public void release()
        Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple ObjectShortMap.clear() should be a better alternative since it'll avoid reallocation.
        Specified by:
        release in interface ObjectShortMap<KType>
        See Also:
        ObjectShortMap.clear()

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface ObjectShortMap<KType>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code of elements stored in the map. The hash code is defined as a sum of hash codes of keys and values stored within the set). Because sum is commutative, this ensures that different order of elements in a set does not affect the hash code.

      • equals

        public boolean equals(java.lang.Object obj)
        Compares the specified object with this set for equality. Returns true if and only if the specified object is also a ObjectShortMap and both objects contains exactly the same key-value pairs.
        Specified by:
        equals in interface ObjectShortMap<KType>
        Overrides:
        equals in class java.lang.Object

      • ensureCapacity

        public void ensureCapacity(int expectedElements)
        Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.
        Specified by:
        ensureCapacity in interface Preallocable
        Parameters:
        expectedElements - The total number of keys, inclusive.

      • iterator

        public java.util.Iterator<ObjectShortCursor<KType>> iterator()
        Returns a cursor over the entries (key-value pairs) in this map. The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next(). To read the current key and value use the cursor's public fields. An example is shown below. 
         for (IntShortCursor c : intShortMap) {
   System.out.println("index=" + c.index + " key=" + c.key + " value=" + c.value);
 }

        The index field inside the cursor gives the internal index inside the container's implementation. The interpretation of this index depends on to the container.

        Specified by:
        iterator in interface ObjectShortAssociativeContainer<KType>
        Specified by:
        iterator in interface java.lang.Iterable<ObjectShortCursor<KType>>

      • forEach

        public <T extends ObjectShortProcedure<? super KType>> T forEach(T procedure)
        Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ObjectShortProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example.
        Specified by:
        forEach in interface ObjectShortAssociativeContainer<KType>

      • forEach

        public <T extends ObjectShortPredicate<? super KType>> T forEach(T predicate)
        Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of ObjectShortPredicate. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example. The iteration is continued as long as the predicate returns true.
        Specified by:
        forEach in interface ObjectShortAssociativeContainer<KType>

      • values

        public ShortCollection values()
        Description copied from interface: ObjectShortAssociativeContainer
        Returns a container view of all values present in this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
        Specified by:
        values in interface ObjectShortAssociativeContainer<KType>
        Returns:
        Returns a container with all values stored in this map.

      • toString

        public java.lang.String toString()
        Convert the contents of this map to a human-friendly string.
        Overrides:
        toString in class java.lang.Object

      • visualizeKeyDistribution

        public java.lang.String visualizeKeyDistribution(int characters)
        Description copied from interface: ObjectShortMap
        Visually depict the distribution of keys.
        Specified by:
        visualizeKeyDistribution in interface ObjectShortMap<KType>
        Parameters:
        characters - The number of characters to "squeeze" the entire buffer into.
        Returns:
        Returns a sequence of characters where '.' depicts an empty fragment of the internal buffer and 'X' depicts full or nearly full capacity within the buffer's range and anything between 1 and 9 is between.

      • from

        public static <KType> ObjectShortHashMap<KType> from(KType[] keys,
                                                     short[] values)
        Creates a hash map from two index-aligned arrays of key-value pairs.
Skip navigation links

DataMelt 3.0 © DataMelt by jWork.ORG

Ads help maintain this website.