Class ReferenceOpenHashBigSet<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>
it.unimi.dsi.fastutil.objects.AbstractReferenceSet<K>
it.unimi.dsi.fastutil.objects.ReferenceOpenHashBigSet<K>
All Implemented Interfaces:
it.unimi.dsi.fastutil.Hash, it.unimi.dsi.fastutil.objects.ObjectIterable<K>, it.unimi.dsi.fastutil.objects.ReferenceCollection<K>, ReferenceSet<K>, it.unimi.dsi.fastutil.Size64, Serializable, Cloneable, Iterable<K>, Collection<K>, Set<K>

public class ReferenceOpenHashBigSet<K> extends AbstractReferenceSet<K> implements Serializable, Cloneable, it.unimi.dsi.fastutil.Hash, it.unimi.dsi.fastutil.Size64
A type-specific hash big set with with a fast, small-footprint implementation.

Instances of this class use a hash table to represent a big set: the number of elements in the set is limited only by the amount of core memory. The table (backed by a big array) 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.

The methods of this class are about 30% slower than those of the corresponding non-big set.

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 int
    The mask for wrapping a base counter.
    protected boolean
    Whether this set contains the null key.
    protected final float
    The acceptable load factor.
    protected K[][]
    The big array of keys.
    protected long
    The mask for wrapping a position counter.
    protected long
    Threshold after which we rehash.
    protected final long
    We never resize below this threshold, which is the construction-time {#n}.
    protected long
    The current table size (always a power of 2).
    protected int
    The mask for wrapping a segment counter.
    protected long
    Number of entries in the 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
    Creates a new hash big set with initial expected Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.
    ReferenceOpenHashBigSet(long expected)
    Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor.
    ReferenceOpenHashBigSet(long expected, float f)
    Creates a new hash big set.
    ReferenceOpenHashBigSet(it.unimi.dsi.fastutil.objects.ReferenceCollection<? extends K> c)
    Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection.
    ReferenceOpenHashBigSet(it.unimi.dsi.fastutil.objects.ReferenceCollection<? extends K> c, float f)
    Creates a new hash big set copying a given type-specific collection.
    Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.
    ReferenceOpenHashBigSet(Collection<? extends K> c, float f)
    Creates a new hash big set copying a given collection.
    Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.
    ReferenceOpenHashBigSet(Iterator<? extends K> i, float f)
    Creates a new hash big set using elements provided by a type-specific iterator.
    Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor copying the elements of an array.
    ReferenceOpenHashBigSet(K[] a, float f)
    Creates a new hash big set copying the elements of an array.
    ReferenceOpenHashBigSet(K[] a, int offset, int length)
    Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.
    ReferenceOpenHashBigSet(K[] a, int offset, int length, float f)
    Creates a new hash big set and fills it with the elements of a given array.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(K k)
     
    boolean
    addAll(Collection<? extends K> c)
     
    void
    Returns a deep copy of this big set.
    boolean
     
    void
    ensureCapacity(long capacity)
    Ensures that this big set can hold a certain number of elements without rehashing.
    void
    forEach(Consumer<? super K> action)
     
    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(long newN)
    Resizes the set.
    boolean
     
    protected final void
    shiftKeys(long pos)
    Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.
    int
    Deprecated.
    long
     
    it.unimi.dsi.fastutil.objects.ObjectSpliterator<K>
    Returns a type-specific spliterator on the elements of this set.
    Returns a Collector that collects a Stream's elements into a new big hash set.
    toBigSetWithExpectedSize(long expectedSize)
    Returns a Collector that collects a Stream's elements into a new big hash set.
    boolean
    Rehashes this set, making the table as small as possible.
    boolean
    trim(long n)
    Rehashes this set if the table is too large.

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

    equals

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

    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 big array of keys.
    • mask

      protected transient long mask
      The mask for wrapping a position counter.
    • segmentMask

      protected transient int segmentMask
      The mask for wrapping a segment counter.
    • baseMask

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

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

      protected transient long n
      The current table size (always a power of 2).
    • maxFill

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

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

      protected final float f
      The acceptable load factor.
    • size

      protected long size
      Number of entries in the set.
  • Constructor Details

    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(long expected, float f)
      Creates a new hash big 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 set.
      f - the load factor.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(long expected)
      Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor.
      Parameters:
      expected - the expected number of elements in the hash big set.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet()
      Creates a new hash big set with initial expected Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(Collection<? extends K> c, float f)
      Creates a new hash big set copying a given collection.
      Parameters:
      c - a Collection to be copied into the new hash big set.
      f - the load factor.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(Collection<? extends K> c)
      Creates a new hash big set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.
      Parameters:
      c - a Collection to be copied into the new hash big set.
    • ReferenceOpenHashBigSet

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

      public ReferenceOpenHashBigSet(it.unimi.dsi.fastutil.objects.ReferenceCollection<? extends K> c)
      Creates a new hash big 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 big set.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(Iterator<? extends K> i, float f)
      Creates a new hash big set using elements provided by a type-specific iterator.
      Parameters:
      i - a type-specific iterator whose elements will fill the new hash big set.
      f - the load factor.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(Iterator<? extends K> i)
      Creates a new hash big 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 new hash big set.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(K[] a, int offset, int length, float f)
      Creates a new hash big set and fills it with the elements of a given array.
      Parameters:
      a - an array whose elements will be used to fill the new hash big set.
      offset - the first element to use.
      length - the number of elements to use.
      f - the load factor.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(K[] a, int offset, int length)
      Creates a new hash big 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 new hash big set.
      offset - the first element to use.
      length - the number of elements to use.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(K[] a, float f)
      Creates a new hash big set copying the elements of an array.
      Parameters:
      a - an array to be copied into the new hash big set.
      f - the load factor.
    • ReferenceOpenHashBigSet

      public ReferenceOpenHashBigSet(K[] a)
      Creates a new hash big 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 big set.
  • Method Details

    • toBigSet

      public static <K> Collector<K,?,ReferenceOpenHashBigSet<K>> toBigSet()
      Returns a Collector that collects a Stream's elements into a new big hash set.
    • toBigSetWithExpectedSize

      public static <K> Collector<K,?,ReferenceOpenHashBigSet<K>> toBigSetWithExpectedSize(long expectedSize)
      Returns a Collector that collects a Stream's elements into a new big hash set.
    • ensureCapacity

      public void ensureCapacity(long capacity)
      Ensures that this big 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>
    • shiftKeys

      protected final void shiftKeys(long 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>
    • clear

      public void clear()

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

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

      public it.unimi.dsi.fastutil.objects.ObjectIterator<K> iterator()
      Description copied from interface: ReferenceSet
      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.ObjectIterable<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ReferenceCollection<K>
      Specified by:
      iterator in interface ReferenceSet<K>
      Specified by:
      iterator in interface Set<K>
      Specified by:
      iterator in class AbstractReferenceSet<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: ReferenceSet
      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.ObjectIterable<K>
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.objects.ReferenceCollection<K>
      Specified by:
      spliterator in interface ReferenceSet<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(long n)
      Rehashes this set if the table is too large.

      Let N be the smallest table size that can hold max(n,size64()) 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(long newN)
      Resizes 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
    • size

      @Deprecated public int size()
      Deprecated.
      Specified by:
      size in interface Collection<K>
      Specified by:
      size in interface Set<K>
      Specified by:
      size in interface it.unimi.dsi.fastutil.Size64
      Specified by:
      size in class AbstractCollection<K>
    • size64

      public long size64()
      Specified by:
      size64 in interface it.unimi.dsi.fastutil.Size64
    • isEmpty

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

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

      This method performs a deep copy of this big 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 big 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 AbstractReferenceSet<K>
      Returns:
      a hash code for this set.