Class ObjectOpenCustomHashSet<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectSet<K>
it.unimi.dsi.fastutil.objects.ObjectOpenCustomHashSet<K>
All Implemented Interfaces:
it.unimi.dsi.fastutil.Hash, it.unimi.dsi.fastutil.objects.ObjectCollection<K>, it.unimi.dsi.fastutil.objects.ObjectIterable<K>, ObjectSet<K>, Serializable, Cloneable, Iterable<K>, Collection<K>, Set<K>

public class ObjectOpenCustomHashSet<K> extends AbstractObjectSet<K> implements Serializable, Cloneable, it.unimi.dsi.fastutil.Hash
A type-specific hash set with a fast, small-footprint implementation whose hashing strategy is specified at creation time.

Instances of this class use a hash table to represent a set. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create sets with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.

Note that clear() does not modify the hash table size. Rather, a family of trimming methods lets you control the size of the table; this is particularly useful if you reuse instances of this class.

See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash

    it.unimi.dsi.fastutil.Hash.Strategy<K>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    Whether this set contains the null key.
    protected final float
    The acceptable load factor.
    protected K[]
    The array of keys.
    protected int
    The mask for wrapping a position counter.
    protected int
    Threshold after which we rehash.
    protected final int
    We never resize below this threshold, which is the construction-time {#n}.
    protected int
    The current table size.
    protected int
    Number of entries in the set (including the null key, if present).
    protected it.unimi.dsi.fastutil.Hash.Strategy<? super K>
    The hash strategy of this custom set.

    Fields inherited from interface it.unimi.dsi.fastutil.Hash

    DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
  • Constructor Summary

    Constructors
    Constructor
    Description
    ObjectOpenCustomHashSet(int expected, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set.
    ObjectOpenCustomHashSet(int expected, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor.
    ObjectOpenCustomHashSet(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with initial expected Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.
    ObjectOpenCustomHashSet(it.unimi.dsi.fastutil.objects.ObjectCollection<? extends K> c, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set copying a given type-specific collection.
    ObjectOpenCustomHashSet(it.unimi.dsi.fastutil.objects.ObjectCollection<? extends K> c, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection.
    ObjectOpenCustomHashSet(Collection<? extends K> c, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set copying a given collection.
    ObjectOpenCustomHashSet(Collection<? extends K> c, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.
    ObjectOpenCustomHashSet(Iterator<? extends K> i, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set using elements provided by a type-specific iterator.
    ObjectOpenCustomHashSet(Iterator<? extends K> i, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.
    ObjectOpenCustomHashSet(K[] a, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set copying the elements of an array.
    ObjectOpenCustomHashSet(K[] a, int offset, int length, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set and fills it with the elements of a given array.
    ObjectOpenCustomHashSet(K[] a, int offset, int length, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.
    ObjectOpenCustomHashSet(K[] a, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying the elements of an array.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(K k)
     
    boolean
    addAll(Collection<? extends K> c)
     
    Add a random element if not present, get the existing value if already present.
    void
    Removes all elements from this set.
    Returns a deep copy of this set.
    boolean
     
    void
    ensureCapacity(int capacity)
    Ensures that this set can hold a certain number of elements without rehashing.
    void
    forEach(Consumer<? super K> action)
     
    Returns the element of this set that is equal to the given key, or null.
    int
    Returns a hash code for this set.
    boolean
     
    it.unimi.dsi.fastutil.objects.ObjectIterator<K>
    Returns a type-specific iterator on the elements of this set.
    protected void
    rehash(int newN)
    Rehashes the set.
    boolean
     
    protected final void
    shiftKeys(int pos)
    Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.
    int
     
    it.unimi.dsi.fastutil.objects.ObjectSpliterator<K>
    Returns a type-specific spliterator on the elements of this set.
    it.unimi.dsi.fastutil.Hash.Strategy<? super K>
    Returns the hashing strategy.
    boolean
    Rehashes this set, making the table as small as possible.
    boolean
    trim(int n)
    Rehashes this set if the table is too large.

    Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectSet

    equals

    Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectCollection

    toString

    Methods inherited from class java.util.AbstractCollection

    containsAll, removeAll, retainAll, toArray, toArray

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.Collection

    parallelStream, removeIf, stream, toArray

    Methods inherited from interface java.util.Set

    containsAll, removeAll, retainAll, toArray, toArray
  • Field Details

    • key

      protected transient K[] key
      The array of keys.
    • mask

      protected transient int mask
      The mask for wrapping a position counter.
    • containsNull

      protected transient boolean containsNull
      Whether this set contains the null key.
    • strategy

      protected it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy
      The hash strategy of this custom set.
    • n

      protected transient int n
      The current table size. Note that an additional element is allocated for storing the null key.
    • maxFill

      protected transient int maxFill
      Threshold after which we rehash. It must be the table size times f.
    • minN

      protected final transient int minN
      We never resize below this threshold, which is the construction-time {#n}.
    • size

      protected int size
      Number of entries in the set (including the null key, if present).
    • f

      protected final float f
      The acceptable load factor.
  • Constructor Details

    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(int expected, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set.

      The actual table size will be the least power of two greater than expected/f.

      Parameters:
      expected - the expected number of elements in the hash set.
      f - the load factor.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(int expected, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor.
      Parameters:
      expected - the expected number of elements in the hash set.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with initial expected Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.
      Parameters:
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(Collection<? extends K> c, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set copying a given collection.
      Parameters:
      c - a Collection to be copied into the new hash set.
      f - the load factor.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(Collection<? extends K> c, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.
      Parameters:
      c - a Collection to be copied into the new hash set.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(it.unimi.dsi.fastutil.objects.ObjectCollection<? extends K> c, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set copying a given type-specific collection.
      Parameters:
      c - a type-specific collection to be copied into the new hash set.
      f - the load factor.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(it.unimi.dsi.fastutil.objects.ObjectCollection<? extends K> c, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection.
      Parameters:
      c - a type-specific collection to be copied into the new hash set.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(Iterator<? extends K> i, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set using elements provided by a type-specific iterator.
      Parameters:
      i - a type-specific iterator whose elements will fill the set.
      f - the load factor.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(Iterator<? extends K> i, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.
      Parameters:
      i - a type-specific iterator whose elements will fill the set.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(K[] a, int offset, int length, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set and fills it with the elements of a given array.
      Parameters:
      a - an array whose elements will be used to fill the set.
      offset - the first element to use.
      length - the number of elements to use.
      f - the load factor.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(K[] a, int offset, int length, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.
      Parameters:
      a - an array whose elements will be used to fill the set.
      offset - the first element to use.
      length - the number of elements to use.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(K[] a, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set copying the elements of an array.
      Parameters:
      a - an array to be copied into the new hash set.
      f - the load factor.
      strategy - the strategy.
    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet(K[] a, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying the elements of an array.
      Parameters:
      a - an array to be copied into the new hash set.
      strategy - the strategy.
  • Method Details

    • strategy

      public it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy()
      Returns the hashing strategy.
      Returns:
      the hashing strategy of this custom hash set.
    • ensureCapacity

      public void ensureCapacity(int capacity)
      Ensures that this set can hold a certain number of elements without rehashing.
      Parameters:
      capacity - a number of elements; there will be no rehashing unless the set size exceeds this number.
    • addAll

      public boolean addAll(Collection<? extends K> c)
      Specified by:
      addAll in interface Collection<K>
      Specified by:
      addAll in interface Set<K>
      Overrides:
      addAll in class AbstractCollection<K>
    • add

      public boolean add(K k)
      Specified by:
      add in interface Collection<K>
      Specified by:
      add in interface Set<K>
      Overrides:
      add in class AbstractCollection<K>
    • addOrGet

      public K addOrGet(K k)
      Add a random element if not present, get the existing value if already present. This is equivalent to (but faster than) doing a:
       K exist = set.get(k);
       if (exist == null) {
         set.add(k);
         exist = k;
       }
       
    • shiftKeys

      protected final void shiftKeys(int pos)
      Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.
      Parameters:
      pos - a starting position.
    • remove

      public boolean remove(Object k)
      Specified by:
      remove in interface Collection<K>
      Specified by:
      remove in interface Set<K>
      Overrides:
      remove in class AbstractCollection<K>
    • contains

      public boolean contains(Object k)
      Specified by:
      contains in interface Collection<K>
      Specified by:
      contains in interface Set<K>
      Overrides:
      contains in class AbstractCollection<K>
    • get

      public K get(Object k)
      Returns the element of this set that is equal to the given key, or null.
      Returns:
      the element of this set that is equal to the given key, or null.
    • clear

      public void clear()
      Removes all elements from this set.

      To increase object reuse, this method does not change the table size. If you want to reduce the table size, you must use trim().

      Specified by:
      clear in interface Collection<K>
      Specified by:
      clear in interface Set<K>
      Overrides:
      clear in class AbstractCollection<K>
    • size

      public int size()
      Specified by:
      size in interface Collection<K>
      Specified by:
      size in interface Set<K>
      Specified by:
      size in class AbstractCollection<K>
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Collection<K>
      Specified by:
      isEmpty in interface Set<K>
      Overrides:
      isEmpty in class AbstractCollection<K>
    • iterator

      public it.unimi.dsi.fastutil.objects.ObjectIterator<K> iterator()
      Description copied from interface: ObjectSet
      Returns a type-specific iterator on the elements of this set.
      Specified by:
      iterator in interface Collection<K>
      Specified by:
      iterator in interface Iterable<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ObjectCollection<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
      Specified by:
      iterator in interface ObjectSet<K>
      Specified by:
      iterator in interface Set<K>
      Specified by:
      iterator in class AbstractObjectSet<K>
      Returns:
      a type-specific iterator on the elements of this set.
    • spliterator

      public it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> spliterator()
      Description copied from interface: ObjectSet
      Returns a type-specific spliterator on the elements of this set.

      Set spliterators must report at least Spliterator.DISTINCT.

      See Set.spliterator() for more documentation on the requirements of the returned spliterator.

      Specified by:
      spliterator in interface Collection<K>
      Specified by:
      spliterator in interface Iterable<K>
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.objects.ObjectCollection<K>
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
      Specified by:
      spliterator in interface ObjectSet<K>
      Specified by:
      spliterator in interface Set<K>
      Returns:
    • forEach

      public void forEach(Consumer<? super K> action)
      Specified by:
      forEach in interface Iterable<K>
    • trim

      public boolean trim()
      Rehashes this set, making the table as small as possible.

      This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.

      If the table size is already the minimum possible, this method does nothing.

      Returns:
      true if there was enough memory to trim the set.
      See Also:
    • trim

      public boolean trim(int n)
      Rehashes this set if the table is too large.

      Let N be the smallest table size that can hold max(n,size()) entries, still satisfying the load factor. If the current table size is smaller than or equal to N, this method does nothing. Otherwise, it rehashes this set in a table of size N.

      This method is useful when reusing sets. Clearing a set leaves the table size untouched. If you are reusing a set many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient sets.

      Parameters:
      n - the threshold for the trimming.
      Returns:
      true if there was enough memory to trim the set.
      See Also:
    • rehash

      protected void rehash(int newN)
      Rehashes the set.

      This method implements the basic rehashing strategy, and may be overriden by subclasses implementing different rehashing strategies (e.g., disk-based rehashing). However, you should not override this method unless you understand the internal workings of this class.

      Parameters:
      newN - the new size
    • clone

      public ObjectOpenCustomHashSet<K> clone()
      Returns a deep copy of this set.

      This method performs a deep copy of this hash set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

      Overrides:
      clone in class Object
      Returns:
      a deep copy of this set.
    • hashCode

      public int hashCode()
      Returns a hash code for this set. This method overrides the generic method provided by the superclass. Since equals() is not overriden, it is important that the value returned by this method is the same value as the one returned by the overriden method.
      Specified by:
      hashCode in interface Collection<K>
      Specified by:
      hashCode in interface Set<K>
      Overrides:
      hashCode in class AbstractObjectSet<K>
      Returns:
      a hash code for this set.