com.carrotsearch.hppc

Interface ObjectSet<KType>

All Superinterfaces:

java.lang.Iterable<ObjectCursor<KType>>, ObjectCollection<KType>, ObjectContainer<KType>

All Known Implementing Classes:

ObjectHashSet, ObjectIdentityHashSet, ObjectScatterSet

@Generated(date="2023-04-24T17:14:50+0800",
           value="KTypeSet.java")
public interface ObjectSet<KType>
extends ObjectCollection<KType>

A set of Objects.

Method Summary

Modifier and Type	Method and Description
boolean	add(KType k) Adds k to the set.
java.lang.String	visualizeKeyDistribution(int characters) Visually depict the distribution of keys.

Methods inherited from interface com.carrotsearch.hppc.ObjectCollection

clear, release, removeAll, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer

contains, forEach, forEach, isEmpty, iterator, size, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

boolean add(KType k)

Adds k to the set.

Returns:

Returns true if this element was not part of the set before. Returns false if an equal element is part of the set, and replaces the existing equal element with the argument (if keys are object types).

visualizeKeyDistribution

java.lang.String visualizeKeyDistribution(int characters)

Visually depict the distribution of keys.

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.