Class IntLinkedOpenHashSet
- All Implemented Interfaces:
Hash
,IntBidirectionalIterable
,IntCollection
,IntIterable
,IntSet
,IntSortedSet
,Serializable
,Cloneable
,Iterable<Integer>
,Collection<Integer>
,SequencedCollection<Integer>
,SequencedSet<Integer>
,Set<Integer>
,SortedSet<Integer>
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.
Iterators generated by this set will enumerate elements in the same order in which they have been added to the set (addition of elements already present in the set does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.
This class implements the interface of a sorted set, so to allow easy access of the iteration
order: for instance, you can get the first element in iteration order with first()
without having to create an iterator; however, this class partially violates the
SortedSet
contract because all subset methods throw an exception and
comparator()
returns always null
.
Additional methods, such as addAndMoveToFirst()
, make it easy to use instances of this
class as a cache (e.g., with LRU policy).
The iterators provided by this class are type-specific list
iterators, and can be started at any element which is in the set (if the provided
element is not in the set, a NoSuchElementException
exception will be thrown). If,
however, the provided element is not the first or last element in the set, the first access to
the list index will require linear time, as in the worst case the entire set must be scanned in
iteration order to retrieve the positional index of the starting element. If you use just the
methods of a type-specific BidirectionalIterator
, however, all
operations will be performed in constant time.
- 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.IntLinkedOpenHashSet
(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.IntLinkedOpenHashSet
(int[] a) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.IntLinkedOpenHashSet
(int[] a, float f) Creates a new hash set copying the elements of an array.IntLinkedOpenHashSet
(int[] 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.IntLinkedOpenHashSet
(int[] a, int offset, int length, float f) Creates a new hash set and fills it with the elements of a given array.IntLinkedOpenHashSet
(int expected, float f) Creates a new hash set.Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific collection.IntLinkedOpenHashSet
(IntCollection c, float f) Creates a new hash set copying a given type-specific collection.Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by a type-specific iterator.IntLinkedOpenHashSet
(IntIterator i, float f) Creates a new hash set using elements provided by a type-specific iterator.IntLinkedOpenHashSet
(Collection<? extends Integer> c) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.IntLinkedOpenHashSet
(Collection<? extends Integer> c, float f) Creates a new hash set copying a given collection.IntLinkedOpenHashSet
(Iterator<?> i) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by an iterator.IntLinkedOpenHashSet
(Iterator<?> i, float f) Creates a new hash set using elements provided by an iterator. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(int k) Ensures that this collection contains the specified element (optional operation).boolean
Adds all elements of the given type-specific collection to this collection.boolean
addAll
(Collection<? extends Integer> c) boolean
addAndMoveToFirst
(int k) Adds a key to the set; if the key is already present, it is moved to the first position of the iteration order.boolean
addAndMoveToLast
(int k) Adds a key to the set; if the key is already present, it is moved to the last position of the iteration order.void
clear()
clone()
Returns a deep copy of this set.boolean
contains
(int k) Returnstrue
if this collection contains the specified element.void
ensureCapacity
(int capacity) Ensures that this set can hold a certain number of elements without rehashing.int
firstInt()
Returns the first element of this set in iteration order.void
forEach
(IntConsumer action) Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.int
hashCode()
Returns a hash code for this set.headSet
(int to) Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.boolean
isEmpty()
iterator()
Returns a type-specific list iterator on the elements in this set, starting from the first element.iterator
(int from) Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.int
lastInt()
Returns the last element of this set in iteration order.static IntLinkedOpenHashSet
of()
Creates a new empty hash set.static IntLinkedOpenHashSet
of
(int e) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using the given element.static IntLinkedOpenHashSet
of
(int... a) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using a list of elements.static IntLinkedOpenHashSet
of
(int e0, int e1) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements given.static IntLinkedOpenHashSet
of
(int e0, int e1, int e2) Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements given.boolean
remove
(int k) Removes an element from this set.int
Removes the first key in iteration order.int
Removes the the last key in iteration order.int
size()
Returns a type-specific spliterator on the elements of this sorted-set.subSet
(int from, int to) Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.tailSet
(int from) Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement
.static IntLinkedOpenHashSet
Collects the result of a primitiveStream
into a new hash set.static IntLinkedOpenHashSet
toSetWithExpectedSize
(IntStream stream, int expectedSize) Collects the result of a primitiveStream
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.ints.AbstractIntSet
equals, rem
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
add, contains, containsAll, containsAll, forEach, remove, removeAll, removeAll, removeIf, retainAll, retainAll, toArray, toIntArray, toIntArray, toString
Methods inherited from class java.util.AbstractCollection
toArray, toArray
Methods inherited from interface java.util.Collection
toArray
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toIntArray, toIntArray
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterable
forEach, forEach
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntSortedSet
first, headSet, last, subSet, tailSet
Methods inherited from interface java.util.Set
add, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArray
Methods inherited from interface java.util.SortedSet
addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed
-
Constructor Details
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet(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.
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet(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.
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet()Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor. -
IntLinkedOpenHashSet
Creates a new hash set copying a given collection.- Parameters:
c
- aCollection
to be copied into the new hash set.f
- the load factor.
-
IntLinkedOpenHashSet
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.
-
IntLinkedOpenHashSet
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.
-
IntLinkedOpenHashSet
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.
-
IntLinkedOpenHashSet
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.
-
IntLinkedOpenHashSet
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.
-
IntLinkedOpenHashSet
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.
-
IntLinkedOpenHashSet
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by an iterator.- Parameters:
i
- an iterator whose elements will fill the set.
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet(int[] 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.
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet(int[] 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.- 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.
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet(int[] 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.
-
IntLinkedOpenHashSet
public IntLinkedOpenHashSet(int[] a) 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
Collects the result of a primitiveStream
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 primitiveCollector
equivalent in the Java API.
-
toSetWithExpectedSize
Collects the result of a primitiveStream
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 primitiveCollector
equivalent in the Java API.
-
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
Description copied from interface:IntCollection
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceIntCollection
- Overrides:
addAll
in classAbstractIntCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
-
addAll
Description copied from class:AbstractIntCollection
- Specified by:
addAll
in interfaceCollection<Integer>
- Specified by:
addAll
in interfaceSet<Integer>
- Overrides:
addAll
in classAbstractIntCollection
-
add
public boolean add(int k) Description copied from class:AbstractIntCollection
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceIntCollection
- Overrides:
add
in classAbstractIntCollection
- See Also:
-
remove
public boolean remove(int k) Description copied from class:AbstractIntSet
Removes an element from this set. Delegates to the type-specificrem()
method implemented by type-specific abstractCollection
superclass.- Specified by:
remove
in interfaceIntSet
- Overrides:
remove
in classAbstractIntSet
- See Also:
-
contains
public boolean contains(int k) Description copied from class:AbstractIntCollection
Returnstrue
if this collection contains the specified element.- Specified by:
contains
in interfaceIntCollection
- Overrides:
contains
in classAbstractIntCollection
- See Also:
-
removeFirstInt
public int removeFirstInt()Removes the first key in iteration order.- Returns:
- the first key.
- Throws:
NoSuchElementException
- is this set is empty.
-
removeLastInt
public int removeLastInt()Removes the the last key in iteration order.- Returns:
- the last key.
- Throws:
NoSuchElementException
- is this set is empty.
-
addAndMoveToFirst
public boolean addAndMoveToFirst(int k) Adds a key to the set; if the key is already present, it is moved to the first position of the iteration order.- Parameters:
k
- the key.- Returns:
- true if the key was not present.
-
addAndMoveToLast
public boolean addAndMoveToLast(int k) Adds a key to the set; if the key is already present, it is moved to the last position of the iteration order.- Parameters:
k
- the key.- Returns:
- true if the key was not present.
-
clear
public void clear()- Specified by:
clear
in interfaceCollection<Integer>
- Specified by:
clear
in interfaceSet<Integer>
- Overrides:
clear
in classAbstractCollection<Integer>
-
size
public int size()- Specified by:
size
in interfaceCollection<Integer>
- Specified by:
size
in interfaceSet<Integer>
- Specified by:
size
in classAbstractCollection<Integer>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceCollection<Integer>
- Specified by:
isEmpty
in interfaceSet<Integer>
- Overrides:
isEmpty
in classAbstractCollection<Integer>
-
firstInt
public int firstInt()Returns the first element of this set in iteration order.- Specified by:
firstInt
in interfaceIntSortedSet
- Returns:
- the first element in iteration order.
- See Also:
-
lastInt
public int lastInt()Returns the last element of this set in iteration order.- Specified by:
lastInt
in interfaceIntSortedSet
- Returns:
- the last element in iteration order.
- See Also:
-
tailSet
Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement
.- Specified by:
tailSet
in interfaceIntSortedSet
- See Also:
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
headSet
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.- Specified by:
headSet
in interfaceIntSortedSet
- See Also:
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
subSet
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.- Specified by:
subSet
in interfaceIntSortedSet
- See Also:
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
comparator
- Specified by:
comparator
in interfaceIntSortedSet
- Specified by:
comparator
in interfaceSortedSet<Integer>
- Implementation Specification:
- This implementation just returns
null
.
-
iterator
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set. Please see the class documentation for implementation details.- Specified by:
iterator
in interfaceIntSortedSet
- Parameters:
from
- an element to start from.- Returns:
- a type-specific list iterator starting at the given element.
- Throws:
IllegalArgumentException
- iffrom
does not belong to the set.
-
iterator
Returns a type-specific list iterator on the elements in this set, starting from the first element. Please see the class documentation for implementation details.- Specified by:
iterator
in interfaceCollection<Integer>
- Specified by:
iterator
in interfaceIntBidirectionalIterable
- Specified by:
iterator
in interfaceIntCollection
- Specified by:
iterator
in interfaceIntIterable
- Specified by:
iterator
in interfaceIntSet
- Specified by:
iterator
in interfaceIntSortedSet
- Specified by:
iterator
in interfaceIterable<Integer>
- Specified by:
iterator
in interfaceSet<Integer>
- Specified by:
iterator
in classAbstractIntSortedSet
- Returns:
- a type-specific list iterator starting at the first element.
- See Also:
-
spliterator
Returns a type-specific spliterator on the elements of this sorted-set.SortedSet spliterators must report at least
Spliterator.DISTINCT
,Spliterator.ORDERED
, andSpliterator.SORTED
. The returned spliterator'sgetComparator()
must be the same (or at the very least, consistent with) this instance'sIntSortedSet.comparator()
.See
SortedSet.spliterator()
for more documentation on the requirements of the returned spliterator.There isn't a way to split efficiently while still preserving order for a linked data structure, so this implementation is just backed by the iterator. Thus, this spliterator is not well optimized for parallel streams.
Note, contrary to the specification of
SortedSet
, this spliterator does not, reportSpliterator.SORTED
. This is because iteration order is based on insertion order, not natural ordering.- Specified by:
spliterator
in interfaceCollection<Integer>
- Specified by:
spliterator
in interfaceIntCollection
- Specified by:
spliterator
in interfaceIntIterable
- Specified by:
spliterator
in interfaceIntSet
- Specified by:
spliterator
in interfaceIntSortedSet
- Specified by:
spliterator
in interfaceIterable<Integer>
- Specified by:
spliterator
in interfaceSet<Integer>
- Specified by:
spliterator
in interfaceSortedSet<Integer>
- Returns:
- a type-specific spliterator on the elements of this collection.
-
forEach
Description copied from interface:IntIterable
Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.- Specified by:
forEach
in interfaceIntIterable
- Parameters:
action
- the action to be performed for each element.- See Also:
-
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<Integer>
- Specified by:
hashCode
in interfaceSet<Integer>
- Overrides:
hashCode
in classAbstractIntSet
- Returns:
- a hash code for this set.
-