Module com.carrotsearch.hppc

Package com.carrotsearch.hppc

Class SortedIterationObjectObjectHashMap<KType,VType>

java.lang.Object

com.carrotsearch.hppc.SortedIterationObjectObjectHashMap<KType,VType>

All Implemented Interfaces:

ObjectObjectAssociativeContainer<KType,VType>, ObjectObjectMap<KType,VType>, Iterable<ObjectObjectCursor<KType,VType>>

@Generated(date="2024-06-04T15:20:17+0200",
           value="SortedIterationKTypeVTypeHashMap.java")
public class SortedIterationObjectObjectHashMap<KType,VType>
extends Object
implements ObjectObjectMap<KType,VType>

Read-only view with sorted iteration order on a delegate ObjectObjectHashMap.

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 ObjectObjectHashMap 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 ObjectObjectHashMap<KType,VType>	delegate
final int[]	iterationOrder

Constructor Summary

Constructors

Constructor	Description
SortedIterationObjectObjectHashMap(ObjectObjectHashMap<KType,VType> delegate, ObjectObjectComparator<KType,VType> comparator)	Creates a read-only view with sorted iteration order on the given delegate map.
SortedIterationObjectObjectHashMap(ObjectObjectHashMap<KType,VType> delegate, Comparator<KType> comparator)	Creates a read-only view with sorted iteration order on the given delegate map.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all keys and values in the container.
boolean	containsKey(KType key)	Returns true if this container has an association to a value for the given key.
<T extends ObjectObjectProcedure<? super KType, ? super VType>> T	forEach(T procedure)	Applies a given procedure to all keys-value pairs in this container.
VType	get(KType key)
VType	getOrDefault(KType key, VType defaultValue)
boolean	indexExists(int index)
VType	indexGet(int index)	Returns the value associated with an existing key.
void	indexInsert(int index, KType key, VType 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).
VType	indexRemove(int index)	Removes a key-value pair at an index previously acquired from ObjectObjectMap.indexOf(KType).
VType	indexReplace(int index, VType newValue)	Replaces the value associated with an existing key and returns any previous value stored for that key.
boolean	isEmpty()
Iterator<ObjectObjectCursor<KType,VType>>	iterator()	Returns a cursor over the entries (key-value pairs) in this map.
ObjectCollection<KType>	keys()	Returns a collection of keys of this container.
VType	put(KType key, VType value)	Place a given key and value in the container.
int	putAll(ObjectObjectAssociativeContainer<? extends KType,? extends VType> 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 ObjectObjectCursor<? extends KType,? extends VType>> iterable)	Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
void	release()	Removes all elements from the collection and additionally releases any internal buffers.
VType	remove(KType key)	Remove all values at the given key.
int	removeAll(ObjectContainer<? super KType> container)	Removes all keys (and associated values) present in a given container.
int	removeAll(ObjectObjectPredicate<? super KType,? super VType> predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	removeAll(ObjectPredicate<? super KType> predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	size()
protected int[]	sortIterationOrder(int[] entryIndexes, ObjectObjectComparator<KType,VType> comparator)	Sort the iteration order array based on the provided comparator on keys and values.
protected int[]	sortIterationOrder(int[] entryIndexes, Comparator<KType> comparator)	Sort the iteration order array based on the provided comparator on the keys.
ObjectContainer<VType>	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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.carrotsearch.hppc.ObjectObjectMap

equals, hashCode, putIfAbsent

Field Details

delegate

public final ObjectObjectHashMap<KType,VType> delegate

iterationOrder

public final int[] iterationOrder

Constructor Details

SortedIterationObjectObjectHashMap

public SortedIterationObjectObjectHashMap(ObjectObjectHashMap<KType,VType> 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.

SortedIterationObjectObjectHashMap

public SortedIterationObjectObjectHashMap(ObjectObjectHashMap<KType,VType> delegate,
 ObjectObjectComparator<KType,VType> 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,
 ObjectObjectComparator<KType,VType> comparator)

Sort the iteration order array based on the provided comparator on keys and values.

iterator

public Iterator<ObjectObjectCursor<KType,VType>> iterator()

Description copied from interface: ObjectObjectAssociativeContainer

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 ObjectObjectAssociativeContainer<KType,VType>

containsKey

public boolean containsKey(KType key)

Description copied from interface: ObjectObjectAssociativeContainer

Returns true if this container has an association to a value for the given key.

Specified by:

containsKey in interface ObjectObjectAssociativeContainer<KType,VType>

size

public int size()

Specified by:

size in interface ObjectObjectAssociativeContainer<KType,VType>

Returns:

Returns the current size (number of assigned keys) in the container.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ObjectObjectAssociativeContainer<KType,VType>

Returns:

Return true if this hash map contains no assigned keys.

removeAll

public int removeAll(ObjectContainer<? super KType> container)

Description copied from interface: ObjectObjectAssociativeContainer

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 ObjectObjectAssociativeContainer<KType,VType>

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: ObjectObjectAssociativeContainer

Removes all keys (and associated values) for which the predicate returns true.

Specified by:

removeAll in interface ObjectObjectAssociativeContainer<KType,VType>

Returns:

Returns the number of elements actually removed as a result of this call.

removeAll

public int removeAll(ObjectObjectPredicate<? super KType,? super VType> predicate)

Description copied from interface: ObjectObjectAssociativeContainer

Removes all keys (and associated values) for which the predicate returns true.

Specified by:

removeAll in interface ObjectObjectAssociativeContainer<KType,VType>

Returns:

Returns the number of elements actually removed as a result of this call.

forEach

public <T extends ObjectObjectProcedure<? super KType,
? super VType>>
T forEach(T procedure)

Description copied from interface: ObjectObjectAssociativeContainer

Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ObjectObjectProcedure. 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 ObjectObjectAssociativeContainer<KType,VType>

forEach

public <T extends ObjectObjectPredicate<? super KType,
? super VType>>
T forEach(T predicate)

Description copied from interface: ObjectObjectAssociativeContainer

Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of ObjectObjectPredicate. 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 ObjectObjectAssociativeContainer<KType,VType>

keys

public ObjectCollection<KType> keys()

Description copied from interface: ObjectObjectAssociativeContainer

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 ObjectObjectAssociativeContainer<KType,VType>

values

public ObjectContainer<VType> values()

Description copied from interface: ObjectObjectAssociativeContainer

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 ObjectObjectAssociativeContainer<KType,VType>

get

public VType get(KType key)

Specified by:

get in interface ObjectObjectMap<KType,VType>

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 VType getOrDefault(KType key,
 VType defaultValue)

Specified by:

getOrDefault in interface ObjectObjectMap<KType,VType>

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 VType put(KType key,
 VType value)

Description copied from interface: ObjectObjectMap

Place a given key and value in the container.

Specified by:

put in interface ObjectObjectMap<KType,VType>

Returns:

The value previously stored under the given key in the map is returned.

putAll

public int putAll(ObjectObjectAssociativeContainer<? extends KType,? extends VType> container)

Description copied from interface: ObjectObjectMap

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 ObjectObjectMap<KType,VType>

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 ObjectObjectCursor<? extends KType,? extends VType>> iterable)

Description copied from interface: ObjectObjectMap

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 ObjectObjectMap<KType,VType>

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.

remove

public VType remove(KType key)

Description copied from interface: ObjectObjectMap

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 ObjectObjectMap<KType,VType>

indexOf

public int indexOf(KType key)

Description copied from interface: ObjectObjectMap

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 ObjectObjectMap<KType,VType>

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:

• ObjectObjectMap.indexExists(int)
• ObjectObjectMap.indexGet(int)
• ObjectObjectMap.indexInsert(int, KType, VType)
• ObjectObjectMap.indexReplace(int, VType)

indexExists

public boolean indexExists(int index)

Specified by:

indexExists in interface ObjectObjectMap<KType,VType>

Parameters:

index - The index of a given key, as returned from ObjectObjectMap.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:

• ObjectObjectMap.indexOf(KType)

indexGet

public VType indexGet(int index)

Description copied from interface: ObjectObjectMap

Returns the value associated with an existing key.

Specified by:

indexGet in interface ObjectObjectMap<KType,VType>

Parameters:

index - The index of an existing key.

Returns:

Returns the value currently associated with the key.

See Also:

• ObjectObjectMap.indexOf(KType)

indexReplace

public VType indexReplace(int index,
 VType newValue)

Description copied from interface: ObjectObjectMap

Replaces the value associated with an existing key and returns any previous value stored for that key.

Specified by:

indexReplace in interface ObjectObjectMap<KType,VType>

Parameters:

index - The index of an existing key.

Returns:

Returns the previous value associated with the key.

See Also:

• ObjectObjectMap.indexOf(KType)

indexInsert

public void indexInsert(int index,
 KType key,
 VType value)

Description copied from interface: ObjectObjectMap

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 ObjectObjectMap<KType,VType>

Parameters:

index - The index of a previously non-existing key, as returned from ObjectObjectMap.indexOf(KType).

See Also:

• ObjectObjectMap.indexOf(KType)

indexRemove

public VType indexRemove(int index)

Description copied from interface: ObjectObjectMap

Removes a key-value pair at an index previously acquired from ObjectObjectMap.indexOf(KType).

Specified by:

indexRemove in interface ObjectObjectMap<KType,VType>

Parameters:

index - The index of the key to remove, as returned from ObjectObjectMap.indexOf(KType).

Returns:

Returns the previous value associated with the key.

See Also:

• ObjectObjectMap.indexOf(KType)

clear

public void clear()

Description copied from interface: ObjectObjectMap

Clear all keys and values in the container.

Specified by:

clear in interface ObjectObjectMap<KType,VType>

See Also:

• ObjectObjectMap.release()

release

public void release()

Description copied from interface: ObjectObjectMap

Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple ObjectObjectMap.clear() should be a better alternative since it'll avoid reallocation.

Specified by:

release in interface ObjectObjectMap<KType,VType>

See Also:

• ObjectObjectMap.clear()

visualizeKeyDistribution

public String visualizeKeyDistribution(int characters)

Description copied from interface: ObjectObjectMap

Visually depict the distribution of keys.

Specified by:

visualizeKeyDistribution in interface ObjectObjectMap<KType,VType>

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.