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

Class SortedIterationObjectLongHashMap<KType>

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

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 ObjectLongHashMap as this may result in a runtime deadlock. See HPPC-103 and HPPC-186 for more information.

  • Field Details

    • delegate

      public final ObjectLongHashMap<KType> delegate

    • iterationOrder

      public final int[] iterationOrder

  • Constructor Details

    • SortedIterationObjectLongHashMap

      public SortedIterationObjectLongHashMap(ObjectLongHashMap<KType> delegate, Comparator<KType> 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.

    • SortedIterationObjectLongHashMap

      public SortedIterationObjectLongHashMap(ObjectLongHashMap<KType> delegate, ObjectLongComparator<KType> 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, Comparator<KType> comparator)
      Sort the iteration order array based on the provided comparator on the keys.

    • sortIterationOrder

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

    • iterator

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

    • containsKey

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

    • size

      public int size()
      Specified by:
      size in interface ObjectLongAssociativeContainer<KType>
      Returns:
      Returns the current size (number of assigned keys) in the container.

    • isEmpty

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

    • removeAll

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

    • removeAll

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

    • removeAll

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

    • forEach

      public <T extends ObjectLongProcedure<? super KType>> T forEach(T procedure)
      Description copied from interface: ObjectLongAssociativeContainer
      Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ObjectLongProcedure. 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 ObjectLongAssociativeContainer<KType>

    • forEach

      public <T extends ObjectLongPredicate<? super KType>> T forEach(T predicate)
      Description copied from interface: ObjectLongAssociativeContainer
      Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of ObjectLongPredicate. 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 ObjectLongAssociativeContainer<KType>

    • keys

      public ObjectCollection<KType> keys()
      Description copied from interface: ObjectLongAssociativeContainer
      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 ObjectLongAssociativeContainer<KType>

    • values

      public LongContainer values()
      Description copied from interface: ObjectLongAssociativeContainer
      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 ObjectLongAssociativeContainer<KType>

    • get

      public long get(KType key)
      Specified by:
      get in interface ObjectLongMap<KType>
      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 long getOrDefault(KType key, long defaultValue)
      Specified by:
      getOrDefault in interface ObjectLongMap<KType>
      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 long put(KType key, long value)
      Description copied from interface: ObjectLongMap
      Place a given key and value in the container.
      Specified by:
      put in interface ObjectLongMap<KType>
      Returns:
      The value previously stored under the given key in the map is returned.

    • putAll

      public int putAll(ObjectLongAssociativeContainer<? extends KType> container)
      Description copied from interface: ObjectLongMap
      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 ObjectLongMap<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(Iterable<? extends ObjectLongCursor<? extends KType>> iterable)
      Description copied from interface: ObjectLongMap
      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 ObjectLongMap<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.

    • putOrAdd

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

    • indexOf

      public int indexOf(KType key)
      Description copied from interface: ObjectLongMap
      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 ObjectLongMap<KType>
      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 ObjectLongMap<KType>
      Parameters:
      index - The index of a given key, as returned from ObjectLongMap.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:

    • indexGet

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

    • indexReplace

      public long indexReplace(int index, long newValue)
      Description copied from interface: ObjectLongMap
      Replaces the value associated with an existing key and returns any previous value stored for that key.
      Specified by:
      indexReplace in interface ObjectLongMap<KType>
      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, KType key, long value)
      Description copied from interface: ObjectLongMap
      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 ObjectLongMap<KType>
      Parameters:
      index - The index of a previously non-existing key, as returned from ObjectLongMap.indexOf(KType).
      See Also:

    • indexRemove

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

    • clear

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

    • release

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

    • visualizeKeyDistribution

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