Package it.unimi.dsi.fastutil.objects

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:
Hash, ObjectCollection<K>, ObjectIterable<K>, ObjectSet<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>
public class ObjectOpenCustomHashSet<K>
extends AbstractObjectSet<K>
implements java.io.Serializable, java.lang.Cloneable, 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:
Hash, HashCommon, Serialized Form

  • Constructor Details

    • ObjectOpenCustomHashSet

      public ObjectOpenCustomHashSet​(int expected, float f, 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, 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​(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​(java.util.Collection<? extends K> c, float f, 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​(java.util.Collection<? extends K> c, 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​(ObjectCollection<? extends K> c, float f, 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​(ObjectCollection<? extends K> c, 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​(java.util.Iterator<? extends K> i, float f, 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​(java.util.Iterator<? extends K> i, 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, 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, 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, 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, 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 Hash.Strategy<? super K> strategy()
      Returns the hashing strategy.
      Returns:
      the hashing strategy of this custom hash set.

    • addAll

      public boolean addAll​(java.util.Collection<? extends K> c)
      Specified by:
      addAll in interface java.util.Collection<K>
      Specified by:
      addAll in interface java.util.Set<K>
      Overrides:
      addAll in class java.util.AbstractCollection<K>

    • add

      public boolean add​(K k)
      Specified by:
      add in interface java.util.Collection<K>
      Specified by:
      add in interface java.util.Set<K>
      Overrides:
      add in class java.util.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;
 }

    • remove

      public boolean remove​(java.lang.Object k)
      Specified by:
      remove in interface java.util.Collection<K>
      Specified by:
      remove in interface java.util.Set<K>
      Overrides:
      remove in class java.util.AbstractCollection<K>

    • contains

      public boolean contains​(java.lang.Object k)
      Specified by:
      contains in interface java.util.Collection<K>
      Specified by:
      contains in interface java.util.Set<K>
      Overrides:
      contains in class java.util.AbstractCollection<K>

    • get

      public K get​(java.lang.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()
      Specified by:
      clear in interface java.util.Collection<K>
      Specified by:
      clear in interface java.util.Set<K>
      Overrides:
      clear in class java.util.AbstractCollection<K>

    • size

      public int size()
      Specified by:
      size in interface java.util.Collection<K>
      Specified by:
      size in interface java.util.Set<K>
      Specified by:
      size in class java.util.AbstractCollection<K>

    • isEmpty

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

    • iterator

      public ObjectIterator<K> iterator()
      Description copied from interface: ObjectCollection
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<K>
      Specified by:
      iterator in interface java.lang.Iterable<K>
      Specified by:
      iterator in interface ObjectCollection<K>
      Specified by:
      iterator in interface ObjectIterable<K>
      Specified by:
      iterator in interface ObjectSet<K>
      Specified by:
      iterator in interface java.util.Set<K>
      Specified by:
      iterator in class AbstractObjectSet<K>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()

    • spliterator

      public 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 java.util.Collection<K>
      Specified by:
      spliterator in interface java.lang.Iterable<K>
      Specified by:
      spliterator in interface ObjectCollection<K>
      Specified by:
      spliterator in interface ObjectIterable<K>
      Specified by:
      spliterator in interface ObjectSet<K>
      Specified by:
      spliterator in interface java.util.Set<K>
      Returns:
      a type-specific spliterator on the elements of this collection.

    • forEach

      public void forEach​(java.util.function.Consumer<? super K> action)
      Specified by:
      forEach in interface java.lang.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(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 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.

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