Module com.carrotsearch.hppc
Package com.carrotsearch.hppc

Class SortedIterationIntIntHashMap

java.lang.Object
com.carrotsearch.hppc.SortedIterationIntIntHashMap
All Implemented Interfaces:
IntIntAssociativeContainer, IntIntMap, Iterable<IntIntCursor>
@Generated(date="2024-06-04T15:20:17+0200", value="SortedIterationKTypeVTypeHashMap.java") public class SortedIterationIntIntHashMap extends Object implements IntIntMap
Read-only view with sorted iteration order on a delegate IntIntHashMap.

In its constructor, this view creates its own iteration order array and sorts it, which is in O(n.log(n)) of the size of the delegate map. Afterward, calls to any method have the same performance as the delegate map.

This view is read-only. In addition, the delegate map must not be modified while the view is used, otherwise the iteration is undefined.

Since this view provides a fixed iteration order, it must not be used to add entries to another IntIntHashMap as this may result in a runtime deadlock. See HPPC-103 and HPPC-186 for more information.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final IntIntHashMap
    delegate
     
    final int[]
    iterationOrder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SortedIterationIntIntHashMap(IntIntHashMap delegate, IntComparator comparator)
    Creates a read-only view with sorted iteration order on the given delegate map.
    SortedIterationIntIntHashMap(IntIntHashMap delegate, IntIntComparator comparator)
    Creates a read-only view with sorted iteration order on the given delegate map.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    addTo(int key, int additionValue)
    An equivalent of calling
    void
    clear()
    Clear all keys and values in the container.
    boolean
    containsKey(int key)
    Returns true if this container has an association to a value for the given key.
    <T extends IntIntProcedure>
    T
    forEach(T procedure)
    Applies a given procedure to all keys-value pairs in this container.
    int
    get(int key)
     
    int
    getOrDefault(int key, int defaultValue)
     
    boolean
    indexExists(int index)
     
    int
    indexGet(int index)
    Returns the value associated with an existing key.
    void
    indexInsert(int index, int key, int value)
    Inserts a key-value pair for a key that is not present in the map.
    int
    indexOf(int 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).
    int
    indexRemove(int index)
    Removes a key-value pair at an index previously acquired from IntIntMap.indexOf(int).
    int
    indexReplace(int index, int newValue)
    Replaces the value associated with an existing key and returns any previous value stored for that key.
    boolean
    isEmpty()
     
    Iterator<IntIntCursor>
    iterator()
    Returns a cursor over the entries (key-value pairs) in this map.
    IntCollection
    keys()
    Returns a collection of keys of this container.
    int
    put(int key, int value)
    Place a given key and value in the container.
    int
    putAll(IntIntAssociativeContainer container)
    Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
    int
    putAll(Iterable<? extends IntIntCursor> iterable)
    Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
    int
    putOrAdd(int key, int putValue, int 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.
    int
    remove(int key)
    Remove all values at the given key.
    int
    removeAll(IntContainer container)
    Removes all keys (and associated values) present in a given container.
    int
    removeAll(IntIntPredicate predicate)
    Removes all keys (and associated values) for which the predicate returns true.
    int
    removeAll(IntPredicate predicate)
    Removes all keys (and associated values) for which the predicate returns true.
    int
    size()
     
    protected int[]
    sortIterationOrder(int[] entryIndexes, IntComparator comparator)
    Sort the iteration order array based on the provided comparator on the keys.
    protected int[]
    sortIterationOrder(int[] entryIndexes, IntIntComparator comparator)
    Sort the iteration order array based on the provided comparator on keys and values.
    IntContainer
    values()
    Returns a container view of all values present in this container.
    String
    visualizeKeyDistribution(int characters)
    Visually depict the distribution of keys.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.carrotsearch.hppc.IntIntMap

    equals, hashCode, putIfAbsent

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Field Details

    • delegate

      public final IntIntHashMap delegate

    • iterationOrder

      public final int[] iterationOrder

  • Constructor Details

    • SortedIterationIntIntHashMap

      public SortedIterationIntIntHashMap(IntIntHashMap delegate, IntComparator comparator)
      Creates a read-only view with sorted iteration order on the given delegate map. The ordering is based on the provided comparator on the keys.

    • SortedIterationIntIntHashMap

      public SortedIterationIntIntHashMap(IntIntHashMap delegate, IntIntComparator comparator)
      Creates a read-only view with sorted iteration order on the given delegate map. The ordering is based on the provided comparator on keys and values.

  • Method Details

    • sortIterationOrder

      protected int[] sortIterationOrder(int[] entryIndexes, IntComparator comparator)
      Sort the iteration order array based on the provided comparator on the keys.

    • sortIterationOrder

      protected int[] sortIterationOrder(int[] entryIndexes, IntIntComparator comparator)
      Sort the iteration order array based on the provided comparator on keys and values.

    • iterator

      public Iterator<IntIntCursor> iterator()
      Description copied from interface: IntIntAssociativeContainer
      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 IntIntAssociativeContainer
      Specified by:
      iterator in interface Iterable<IntIntCursor>

    • containsKey

      public boolean containsKey(int key)
      Description copied from interface: IntIntAssociativeContainer
      Returns true if this container has an association to a value for the given key.
      Specified by:
      containsKey in interface IntIntAssociativeContainer

    • size

      public int size()
      Specified by:
      size in interface IntIntAssociativeContainer
      Returns:
      Returns the current size (number of assigned keys) in the container.

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface IntIntAssociativeContainer
      Returns:
      Return true if this hash map contains no assigned keys.

    • removeAll

      public int removeAll(IntContainer container)
      Description copied from interface: IntIntAssociativeContainer
      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 IntIntAssociativeContainer
      Returns:
      Returns the number of elements actually removed as a result of this call.

    • removeAll

      public int removeAll(IntPredicate predicate)
      Description copied from interface: IntIntAssociativeContainer
      Removes all keys (and associated values) for which the predicate returns true.
      Specified by:
      removeAll in interface IntIntAssociativeContainer
      Returns:
      Returns the number of elements actually removed as a result of this call.

    • removeAll

      public int removeAll(IntIntPredicate predicate)
      Description copied from interface: IntIntAssociativeContainer
      Removes all keys (and associated values) for which the predicate returns true.
      Specified by:
      removeAll in interface IntIntAssociativeContainer
      Returns:
      Returns the number of elements actually removed as a result of this call.

    • forEach

      public <T extends IntIntProcedure> T forEach(T procedure)
      Description copied from interface: IntIntAssociativeContainer
      Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of IntIntProcedure. This lets the caller call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values.
      Specified by:
      forEach in interface IntIntAssociativeContainer

    • forEach

      public <T extends IntIntPredicate> T forEach(T predicate)
      Description copied from interface: IntIntAssociativeContainer
      Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of IntIntPredicate. This lets the caller call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values.

      The iteration is continued as long as the predicate returns true.

      Specified by:
      forEach in interface IntIntAssociativeContainer

    • keys

      public IntCollection keys()
      Description copied from interface: IntIntAssociativeContainer
      Returns a collection of keys of 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:
      keys in interface IntIntAssociativeContainer

    • values

      public IntContainer values()
      Description copied from interface: IntIntAssociativeContainer
      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 IntIntAssociativeContainer

    • get

      public int get(int key)
      Specified by:
      get in interface IntIntMap
      Returns:
      Returns the value associated with the given key or the default value for the value type, if the key is not associated with any value. For numeric value types, this default value is 0, for object types it is null.

    • getOrDefault

      public int getOrDefault(int key, int defaultValue)
      Specified by:
      getOrDefault in interface IntIntMap
      Returns:
      Returns the value associated with the given key or the provided default value if the key is not associated with any value.

    • put

      public int put(int key, int value)
      Description copied from interface: IntIntMap
      Place a given key and value in the container.
      Specified by:
      put in interface IntIntMap
      Returns:
      The value previously stored under the given key in the map is returned.

    • putAll

      public int putAll(IntIntAssociativeContainer container)
      Description copied from interface: IntIntMap
      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 IntIntMap
      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(Iterable<? extends IntIntCursor> iterable)
      Description copied from interface: IntIntMap
      Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
      Specified by:
      putAll in interface IntIntMap
      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.

    • putOrAdd

      public int putOrAdd(int key, int putValue, int incrementValue)
      Description copied from interface: IntIntMap
      If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.
      Specified by:
      putOrAdd in interface IntIntMap
      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 int addTo(int key, int additionValue)
      Description copied from interface: IntIntMap
      An equivalent of calling 
       putOrAdd(key, additionValue, additionValue);
      Specified by:
      addTo in interface IntIntMap
      Parameters:
      key - The key of the value to adjust.
      additionValue - 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 int remove(int key)
      Description copied from interface: IntIntMap
      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 IntIntMap

    • indexOf

      public int indexOf(int key)
      Description copied from interface: IntIntMap
      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).

      The semantics of "indexes" are not strictly defined. Indexes may (and typically won't be) contiguous.

      The index is valid only between map modifications (it will not be affected by read-only operations like iteration or value retrievals).

      Specified by:
      indexOf in interface IntIntMap
      Parameters:
      key - The key to locate in the map.
      Returns:
      A non-negative value of the logical "index" of the key in the map or a negative value if the key did not exist.
      See Also:

    • indexExists

      public boolean indexExists(int index)
      Specified by:
      indexExists in interface IntIntMap
      Parameters:
      index - The index of a given key, as returned from IntIntMap.indexOf(int).
      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:

    • indexGet

      public int indexGet(int index)
      Description copied from interface: IntIntMap
      Returns the value associated with an existing key.
      Specified by:
      indexGet in interface IntIntMap
      Parameters:
      index - The index of an existing key.
      Returns:
      Returns the value currently associated with the key.
      See Also:

    • indexReplace

      public int indexReplace(int index, int newValue)
      Description copied from interface: IntIntMap
      Replaces the value associated with an existing key and returns any previous value stored for that key.
      Specified by:
      indexReplace in interface IntIntMap
      Parameters:
      index - The index of an existing key.
      Returns:
      Returns the previous value associated with the key.
      See Also:

    • indexInsert

      public void indexInsert(int index, int key, int value)
      Description copied from interface: IntIntMap
      Inserts a key-value pair for a key that is not present in the map. This method may help in avoiding double recalculation of the key's hash.
      Specified by:
      indexInsert in interface IntIntMap
      Parameters:
      index - The index of a previously non-existing key, as returned from IntIntMap.indexOf(int).
      See Also:

    • indexRemove

      public int indexRemove(int index)
      Description copied from interface: IntIntMap
      Removes a key-value pair at an index previously acquired from IntIntMap.indexOf(int).
      Specified by:
      indexRemove in interface IntIntMap
      Parameters:
      index - The index of the key to remove, as returned from IntIntMap.indexOf(int).
      Returns:
      Returns the previous value associated with the key.
      See Also:

    • clear

      public void clear()
      Description copied from interface: IntIntMap
      Clear all keys and values in the container.
      Specified by:
      clear in interface IntIntMap
      See Also:

    • release

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

    • visualizeKeyDistribution

      public String visualizeKeyDistribution(int characters)
      Description copied from interface: IntIntMap
      Visually depict the distribution of keys.
      Specified by:
      visualizeKeyDistribution in interface IntIntMap
      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.