Class LongOpenHashSet

java.lang.Object
java.util.AbstractCollection<java.lang.Long>
All Implemented Interfaces:
Hash, LongCollection, LongIterable, LongSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>

public class LongOpenHashSet
extends AbstractLongSet
implements java.io.Serializable, java.lang.Cloneable, 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:
Hash, HashCommon, Serialized Form
  • Constructor Details

    • LongOpenHashSet

      public LongOpenHashSet​(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.
    • LongOpenHashSet

      public LongOpenHashSet​(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.
    • LongOpenHashSet

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

      public LongOpenHashSet​(java.util.Collection<? extends java.lang.Long> 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.
    • LongOpenHashSet

      public LongOpenHashSet​(java.util.Collection<? extends java.lang.Long> 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.
    • LongOpenHashSet

      public LongOpenHashSet​(LongCollection 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.
    • LongOpenHashSet

      public LongOpenHashSet​(LongCollection 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.
    • LongOpenHashSet

      public LongOpenHashSet​(LongIterator 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.
    • LongOpenHashSet

      public LongOpenHashSet​(LongIterator 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.
    • LongOpenHashSet

      public LongOpenHashSet​(java.util.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.
    • LongOpenHashSet

      public LongOpenHashSet​(java.util.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.
    • LongOpenHashSet

      public LongOpenHashSet​(long[] 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.
    • LongOpenHashSet

      public LongOpenHashSet​(long[] 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.
    • LongOpenHashSet

      public LongOpenHashSet​(long[] 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.
    • LongOpenHashSet

      public LongOpenHashSet​(long[] 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 LongOpenHashSet of()
      Creates a new empty hash set.
      Returns:
      a new empty hash set.
    • of

      public static LongOpenHashSet of​(long 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 LongOpenHashSet of​(long e0, long 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:
      java.lang.IllegalArgumentException - if there were duplicate entries.
    • of

      public static LongOpenHashSet of​(long e0, long e1, long 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:
      java.lang.IllegalArgumentException - if there were duplicate entries.
    • of

      public static LongOpenHashSet of​(long... 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:
      java.lang.IllegalArgumentException - if a duplicate entry was encountered.
    • toSet

      public static LongOpenHashSet toSet​(java.util.stream.LongStream stream)
      Collects the result of a primitive Stream into a new hash set.

      This method performs a terminal operation on the given Stream

      API Notes:
      Taking a primitive stream instead of returning something like a Collector is necessary because there is no primitive Collector equivalent in the Java API.
    • toSetWithExpectedSize

      public static LongOpenHashSet toSetWithExpectedSize​(java.util.stream.LongStream stream, int expectedSize)
      Collects the result of a primitive Stream into a new hash set, potentially pre-allocated to handle the given size.

      This method performs a terminal operation on the given Stream

      API Notes:
      Taking a primitive stream instead returning something like a Collector is necessary because there is no primitive Collector equivalent in the Java API.
    • addAll

      public boolean addAll​(LongCollection c)
      Description copied from interface: LongCollection
      Adds all elements of the given type-specific collection to this collection.
      Specified by:
      addAll in interface LongCollection
      Overrides:
      addAll in class AbstractLongCollection
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.addAll(Collection)
    • addAll

      public boolean addAll​(java.util.Collection<? extends java.lang.Long> c)
      Description copied from class: AbstractLongCollection
      Specified by:
      addAll in interface java.util.Collection<java.lang.Long>
      Specified by:
      addAll in interface java.util.Set<java.lang.Long>
      Overrides:
      addAll in class AbstractLongCollection
    • add

      public boolean add​(long k)
      Description copied from class: AbstractLongCollection
      Ensures that this collection contains the specified element (optional operation).
      Specified by:
      add in interface LongCollection
      Overrides:
      add in class AbstractLongCollection
      See Also:
      Collection.add(Object)
    • remove

      public boolean remove​(long k)
      Description copied from class: AbstractLongSet
      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 LongSet
      Overrides:
      remove in class AbstractLongSet
      See Also:
      Collection.remove(Object)
    • contains

      public boolean contains​(long k)
      Description copied from class: AbstractLongCollection
      Returns true if this collection contains the specified element.
      Specified by:
      contains in interface LongCollection
      Overrides:
      contains in class AbstractLongCollection
      See Also:
      Collection.contains(Object)
    • clear

      public void clear()
      Specified by:
      clear in interface java.util.Collection<java.lang.Long>
      Specified by:
      clear in interface java.util.Set<java.lang.Long>
      Overrides:
      clear in class java.util.AbstractCollection<java.lang.Long>
    • size

      public int size()
      Specified by:
      size in interface java.util.Collection<java.lang.Long>
      Specified by:
      size in interface java.util.Set<java.lang.Long>
      Specified by:
      size in class java.util.AbstractCollection<java.lang.Long>
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface java.util.Collection<java.lang.Long>
      Specified by:
      isEmpty in interface java.util.Set<java.lang.Long>
      Overrides:
      isEmpty in class java.util.AbstractCollection<java.lang.Long>
    • iterator

      public LongIterator iterator()
      Description copied from interface: LongCollection
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<java.lang.Long>
      Specified by:
      iterator in interface java.lang.Iterable<java.lang.Long>
      Specified by:
      iterator in interface LongCollection
      Specified by:
      iterator in interface LongIterable
      Specified by:
      iterator in interface LongSet
      Specified by:
      iterator in interface java.util.Set<java.lang.Long>
      Specified by:
      iterator in class AbstractLongSet
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()
    • spliterator

      public LongSpliterator spliterator()
      Description copied from interface: LongSet
      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 java.util.Collection<java.lang.Long>
      Specified by:
      spliterator in interface java.lang.Iterable<java.lang.Long>
      Specified by:
      spliterator in interface LongCollection
      Specified by:
      spliterator in interface LongIterable
      Specified by:
      spliterator in interface LongSet
      Specified by:
      spliterator in interface java.util.Set<java.lang.Long>
      Returns:
      a type-specific spliterator on the elements of this collection.
    • forEach

      public void forEach​(java.util.function.LongConsumer action)
      Description copied from interface: LongIterable
      Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
      Specified by:
      forEach in interface LongIterable
      Parameters:
      action - the action to be performed for each element.
      See Also:
      Iterable.forEach(java.util.function.Consumer)
    • 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(int)
    • 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:
      trim()
    • clone

      public LongOpenHashSet 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.

      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 java.util.Collection<java.lang.Long>
      Specified by:
      hashCode in interface java.util.Set<java.lang.Long>
      Overrides:
      hashCode in class AbstractLongSet
      Returns:
      a hash code for this set.