Class ByteOpenHashSet

java.lang.Object
java.util.AbstractCollection<Byte>
it.unimi.dsi.fastutil.bytes.AbstractByteCollection
it.unimi.dsi.fastutil.bytes.AbstractByteSet
it.unimi.dsi.fastutil.bytes.ByteOpenHashSet
All Implemented Interfaces:
it.unimi.dsi.fastutil.bytes.ByteCollection, it.unimi.dsi.fastutil.bytes.ByteIterable, ByteSet, it.unimi.dsi.fastutil.Hash, Serializable, Cloneable, Iterable<Byte>, Collection<Byte>, Set<Byte>

public class ByteOpenHashSet extends AbstractByteSet implements Serializable, Cloneable, it.unimi.dsi.fastutil.Hash
A type-specific hash set with with a fast, small-footprint implementation.

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 byte[]
    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).

    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 set with initial expected Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.
    ByteOpenHashSet(byte[] a)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying the elements of an array.
    ByteOpenHashSet(byte[] a, float f)
    Creates a new hash set copying the elements of an array.
    ByteOpenHashSet(byte[] a, int offset, int length)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.
    ByteOpenHashSet(byte[] a, int offset, int length, float f)
    Creates a new hash set and fills it with the elements of a given array.
    ByteOpenHashSet(int expected)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor.
    ByteOpenHashSet(int expected, float f)
    Creates a new hash set.
    ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection.
    ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c, float f)
    Creates a new hash set copying a given type-specific collection.
    ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.
    ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i, float f)
    Creates a new hash set using elements provided by a type-specific iterator.
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.
    ByteOpenHashSet(Collection<? extends Byte> c, float f)
    Creates a new hash set copying a given collection.
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator.
    ByteOpenHashSet(Iterator<?> i, float f)
    Creates a new hash set using elements provided by an iterator.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(byte k)
     
    boolean
    addAll(it.unimi.dsi.fastutil.bytes.ByteCollection c)
     
    boolean
    addAll(Collection<? extends Byte> c)
     
    void
    Removes all elements from this set.
    Returns a deep copy of this set.
    boolean
    contains(byte k)
     
    void
    ensureCapacity(int capacity)
    Ensures that this set can hold a certain number of elements without rehashing.
    void
    forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer action)
     
    int
    Returns a hash code for this set.
    boolean
     
    it.unimi.dsi.fastutil.bytes.ByteIterator
    Returns a type-specific iterator on the elements of this set.
    of()
    Creates a new empty hash set.
    of(byte e)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using the given element.
    of(byte... a)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using a list of elements.
    of(byte e0, byte e1)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements given.
    of(byte e0, byte e1, byte e2)
    Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements given.
    protected void
    rehash(int newN)
    Rehashes the set.
    boolean
    remove(byte k)
    Removes an element from this set.
    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.bytes.ByteSpliterator
    Returns a type-specific spliterator on the elements of this set.
    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.bytes.AbstractByteSet

    equals, rem

    Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection

    add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toByteArray, toByteArray, toString

    Methods inherited from class java.util.AbstractCollection

    toArray, toArray

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection

    containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toByteArray, toByteArray

    Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable

    forEach, forEach

    Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteSet

    add, contains, remove

    Methods inherited from interface java.util.Collection

    toArray

    Methods inherited from interface java.util.Set

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

    • key

      protected transient byte[] 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.
    • 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

    • ByteOpenHashSet

      public ByteOpenHashSet(int expected, float f)
      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.
    • ByteOpenHashSet

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

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

      public ByteOpenHashSet(Collection<? extends Byte> c, float f)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(Collection<? extends Byte> c)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c, float f)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i, float f)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i)
      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.
    • ByteOpenHashSet

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

      public ByteOpenHashSet(Iterator<?> i)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator.
      Parameters:
      i - an iterator whose elements will fill the set.
    • ByteOpenHashSet

      public ByteOpenHashSet(byte[] a, int offset, int length, float f)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(byte[] a, int offset, int length)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(byte[] a, float f)
      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.
    • ByteOpenHashSet

      public ByteOpenHashSet(byte[] a)
      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.
  • Method Details

    • of

      public static ByteOpenHashSet of()
      Creates a new empty hash set.
      Returns:
      a new empty hash set.
    • of

      public static ByteOpenHashSet of(byte e)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using the given element.
      Parameters:
      e - the element that the returned set will contain.
      Returns:
      a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor containing e.
    • of

      public static ByteOpenHashSet of(byte e0, byte e1)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements given.
      Parameters:
      e0 - the first element.
      e1 - the second element.
      Returns:
      a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor containing e0 and e1.
      Throws:
      IllegalArgumentException - if there were duplicate entries.
    • of

      public static ByteOpenHashSet of(byte e0, byte e1, byte e2)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements given.
      Parameters:
      e0 - the first element.
      e1 - the second element.
      e2 - the third element.
      Returns:
      a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor containing e0, e1, and e2.
      Throws:
      IllegalArgumentException - if there were duplicate entries.
    • of

      public static ByteOpenHashSet of(byte... a)
      Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using a list of elements.
      Parameters:
      a - a list of elements that will be used to initialize the new hash set.
      Returns:
      a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor containing the elements of a.
      Throws:
      IllegalArgumentException - if a duplicate entry was encountered.
    • 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(it.unimi.dsi.fastutil.bytes.ByteCollection c)
      Specified by:
      addAll in interface it.unimi.dsi.fastutil.bytes.ByteCollection
      Overrides:
      addAll in class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
    • addAll

      public boolean addAll(Collection<? extends Byte> c)
      Specified by:
      addAll in interface Collection<Byte>
      Specified by:
      addAll in interface Set<Byte>
      Overrides:
      addAll in class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
    • add

      public boolean add(byte k)
      Specified by:
      add in interface it.unimi.dsi.fastutil.bytes.ByteCollection
      Overrides:
      add in class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
    • 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(byte k)
      Description copied from class: AbstractByteSet
      Removes an element from this set. Delegates to the type-specific rem() method implemented by type-specific abstract Collection superclass.
      Specified by:
      remove in interface ByteSet
      Overrides:
      remove in class AbstractByteSet
      See Also:
    • contains

      public boolean contains(byte k)
      Specified by:
      contains in interface it.unimi.dsi.fastutil.bytes.ByteCollection
      Overrides:
      contains in class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
    • 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<Byte>
      Specified by:
      clear in interface Set<Byte>
      Overrides:
      clear in class AbstractCollection<Byte>
    • size

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

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

      public it.unimi.dsi.fastutil.bytes.ByteIterator iterator()
      Description copied from interface: ByteSet
      Returns a type-specific iterator on the elements of this set.
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.bytes.ByteCollection
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.bytes.ByteIterable
      Specified by:
      iterator in interface ByteSet
      Specified by:
      iterator in interface Collection<Byte>
      Specified by:
      iterator in interface Iterable<Byte>
      Specified by:
      iterator in interface Set<Byte>
      Specified by:
      iterator in class AbstractByteSet
      Returns:
      a type-specific iterator on the elements of this set.
    • spliterator

      public it.unimi.dsi.fastutil.bytes.ByteSpliterator spliterator()
      Description copied from interface: ByteSet
      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 it.unimi.dsi.fastutil.bytes.ByteCollection
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.bytes.ByteIterable
      Specified by:
      spliterator in interface ByteSet
      Specified by:
      spliterator in interface Collection<Byte>
      Specified by:
      spliterator in interface Iterable<Byte>
      Specified by:
      spliterator in interface Set<Byte>
      Returns:
    • forEach

      public void forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer action)
      Specified by:
      forEach in interface it.unimi.dsi.fastutil.bytes.ByteIterable
    • 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 ByteOpenHashSet 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<Byte>
      Specified by:
      hashCode in interface Set<Byte>
      Overrides:
      hashCode in class AbstractByteSet
      Returns:
      a hash code for this set.