Class ReferenceOpenHashSet<K>
- All Implemented Interfaces:
Hash
,ObjectIterable<K>
,ReferenceCollection<K>
,ReferenceSet<K>
,Serializable
,Cloneable
,Iterable<K>
,Collection<K>
,Set<K>
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
Hash.Strategy<K>
-
Field Summary
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
ConstructorDescriptionCreates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.ReferenceOpenHashSet
(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.ReferenceOpenHashSet
(int expected, float f) Creates a new hash set.ReferenceOpenHashSet
(ReferenceCollection<? extends K> c) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific collection.ReferenceOpenHashSet
(ReferenceCollection<? extends K> c, float f) Creates a new hash set copying a given type-specific collection.ReferenceOpenHashSet
(Collection<? extends K> c) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.ReferenceOpenHashSet
(Collection<? extends K> c, float f) Creates a new hash set copying a given collection.ReferenceOpenHashSet
(Iterator<? extends K> i) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by a type-specific iterator.ReferenceOpenHashSet
(Iterator<? extends K> i, float f) Creates a new hash set using elements provided by a type-specific iterator.ReferenceOpenHashSet
(K[] a) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.ReferenceOpenHashSet
(K[] a, float f) Creates a new hash set copying the elements of an array.ReferenceOpenHashSet
(K[] a, int offset, int length) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor and fills it with the elements of a given array.ReferenceOpenHashSet
(K[] a, int offset, int length, float f) Creates a new hash set and fills it with the elements of a given array. -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
addAll
(Collection<? extends K> c) void
clear()
clone()
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
int
hashCode()
Returns a hash code for this set.boolean
isEmpty()
iterator()
Returns a type-specific iterator on the elements of this collection.static <K> ReferenceOpenHashSet
<K> of()
Creates a new empty hash set.static <K> ReferenceOpenHashSet
<K> of
(K e) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using the given element.static <K> ReferenceOpenHashSet
<K> of
(K... a) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using a list of elements.static <K> ReferenceOpenHashSet
<K> of
(K e0, K e1) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements given.static <K> ReferenceOpenHashSet
<K> of
(K e0, K e1, K e2) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements given.boolean
int
size()
Returns a type-specific spliterator on the elements of this set.static <K> Collector
<K, ?, ReferenceOpenHashSet<K>> toSet()
Returns aCollector
that collects aStream
's elements into a new hash set.static <K> Collector
<K, ?, ReferenceOpenHashSet<K>> toSetWithExpectedSize
(int expectedSize) Returns aCollector
that collects aStream
's elements into a new hash set, potentially pre-allocated to handle the given size.boolean
trim()
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.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 interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
Constructor Details
-
ReferenceOpenHashSet
public ReferenceOpenHashSet(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.
-
ReferenceOpenHashSet
public ReferenceOpenHashSet(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
expected
- the expected number of elements in the hash set.
-
ReferenceOpenHashSet
public ReferenceOpenHashSet()Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor. -
ReferenceOpenHashSet
Creates a new hash set copying a given collection.- Parameters:
c
- aCollection
to be copied into the new hash set.f
- the load factor.
-
ReferenceOpenHashSet
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.- Parameters:
c
- aCollection
to be copied into the new hash set.
-
ReferenceOpenHashSet
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.
-
ReferenceOpenHashSet
Creates a new hash set withHash.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.
-
ReferenceOpenHashSet
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.
-
ReferenceOpenHashSet
Creates a new hash set withHash.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.
-
ReferenceOpenHashSet
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.
-
ReferenceOpenHashSet
Creates a new hash set withHash.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.
-
ReferenceOpenHashSet
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.
-
ReferenceOpenHashSet
Creates a new hash set withHash.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
Creates a new empty hash set.- Returns:
- a new empty hash set.
-
of
Creates a new hash set withHash.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 containinge
.
-
of
Creates a new hash set withHash.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 containinge0
ande1
. - Throws:
IllegalArgumentException
- if there were duplicate entries.
-
of
Creates a new hash set withHash.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 containinge0
,e1
, ande2
. - Throws:
IllegalArgumentException
- if there were duplicate entries.
-
of
Creates a new hash set withHash.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 ofa
. - Throws:
IllegalArgumentException
- if a duplicate entry was encountered.
-
toSet
Returns aCollector
that collects aStream
's elements into a new hash set. -
toSetWithExpectedSize
Returns aCollector
that collects aStream
's elements into a new hash set, potentially pre-allocated to handle the given size. -
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
- Specified by:
addAll
in interfaceCollection<K>
- Specified by:
addAll
in interfaceSet<K>
- Overrides:
addAll
in classAbstractCollection<K>
-
add
- Specified by:
add
in interfaceCollection<K>
- Specified by:
add
in interfaceSet<K>
- Overrides:
add
in classAbstractCollection<K>
-
remove
- Specified by:
remove
in interfaceCollection<K>
- Specified by:
remove
in interfaceSet<K>
- Overrides:
remove
in classAbstractCollection<K>
-
contains
- Specified by:
contains
in interfaceCollection<K>
- Specified by:
contains
in interfaceSet<K>
- Overrides:
contains
in classAbstractCollection<K>
-
clear
public void clear()- Specified by:
clear
in interfaceCollection<K>
- Specified by:
clear
in interfaceSet<K>
- Overrides:
clear
in classAbstractCollection<K>
-
size
public int size()- Specified by:
size
in interfaceCollection<K>
- Specified by:
size
in interfaceSet<K>
- Specified by:
size
in classAbstractCollection<K>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceCollection<K>
- Specified by:
isEmpty
in interfaceSet<K>
- Overrides:
isEmpty
in classAbstractCollection<K>
-
iterator
Description copied from interface:ReferenceCollection
Returns a type-specific iterator on the elements of this collection.- Specified by:
iterator
in interfaceCollection<K>
- Specified by:
iterator
in interfaceIterable<K>
- Specified by:
iterator
in interfaceObjectIterable<K>
- Specified by:
iterator
in interfaceReferenceCollection<K>
- Specified by:
iterator
in interfaceReferenceSet<K>
- Specified by:
iterator
in interfaceSet<K>
- Specified by:
iterator
in classAbstractReferenceSet<K>
- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
-
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 interfaceCollection<K>
- Specified by:
spliterator
in interfaceIterable<K>
- Specified by:
spliterator
in interfaceObjectIterable<K>
- Specified by:
spliterator
in interfaceReferenceCollection<K>
- Specified by:
spliterator
in interfaceReferenceSet<K>
- Specified by:
spliterator
in interfaceSet<K>
- Returns:
- a type-specific spliterator on the elements of this collection.
-
forEach
-
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,
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.size()
)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:
-
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. Sinceequals()
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 interfaceCollection<K>
- Specified by:
hashCode
in interfaceSet<K>
- Overrides:
hashCode
in classAbstractReferenceSet<K>
- Returns:
- a hash code for this set.
-