public class IntLinkedOpenHashSet extends AbstractIntSortedSet implements Serializable, Cloneable, Hash
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, 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.
Hash,
HashCommon,
Serialized FormHash.Strategy<K>DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
IntLinkedOpenHashSet()
Creates a new hash set with initial expected
Hash.DEFAULT_INITIAL_SIZE elements and
Hash.DEFAULT_LOAD_FACTOR as load factor. |
IntLinkedOpenHashSet(Collection<? extends Integer> c)
Creates a new hash set with
Hash.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(int expected)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load
factor. |
IntLinkedOpenHashSet(int[] a)
Creates a new hash set with
Hash.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 with
Hash.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(IntCollection c)
Creates a new hash set with
Hash.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.
|
IntLinkedOpenHashSet(int expected,
float f)
Creates a new hash set.
|
IntLinkedOpenHashSet(IntIterator i)
Creates a new hash set with
Hash.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(Iterator<?> i)
Creates a new hash set with
Hash.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.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(int k) |
boolean |
addAll(Collection<? extends Integer> c)
Adds all elements of the given collection to this collection.
|
boolean |
addAll(IntCollection c)
Adds all elements of the given type-specific collection to this
collection.
|
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() |
IntLinkedOpenHashSet |
clone()
Returns a deep copy of this set.
|
IntComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it
uses its elements' natural ordering.
|
boolean |
contains(int k) |
int |
firstInt()
Returns the first element of this set in iteration order.
|
int |
growthFactor()
Deprecated.
Since
fastutil 6.1.0, hash tables are doubled
when they are too full. |
void |
growthFactor(int growthFactor)
Deprecated.
Since
fastutil 6.1.0, hash tables are doubled
when they are too full. |
int |
hashCode()
Returns a hash code for this set.
|
IntSortedSet |
headSet(int to) |
boolean |
isEmpty() |
IntListIterator |
iterator()
Returns a type-specific iterator on the elements of this collection.
|
IntListIterator |
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.
|
boolean |
rehash()
Deprecated.
A no-op.
|
boolean |
rem(int k)
|
int |
removeFirstInt()
Removes the first key in iteration order.
|
int |
removeLastInt()
Removes the the last key in iteration order.
|
int |
size() |
IntSortedSet |
subSet(int from,
int to) |
IntSortedSet |
tailSet(int from) |
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.
|
first, headSet, intIterator, last, subSet, tailSetequals, removeadd, contains, containsAll, containsAll, rem, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray, toIntArray, toStringcontainsAll, removeAll, retainAll, toArray, toArray, toIntArray, toIntArrayspliteratoradd, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArrayparallelStream, removeIf, streampublic IntLinkedOpenHashSet(int expected,
float f)
The actual table size will be the least power of two greater than
expected/f.
expected - the expected number of elements in the hash set.f - the load factor.public IntLinkedOpenHashSet(int expected)
Hash.DEFAULT_LOAD_FACTOR as load
factor.expected - the expected number of elements in the hash set.public IntLinkedOpenHashSet()
Hash.DEFAULT_INITIAL_SIZE elements and
Hash.DEFAULT_LOAD_FACTOR as load factor.public IntLinkedOpenHashSet(Collection<? extends Integer> c, float f)
c - a Collection to be copied into the new hash set.f - the load factor.public IntLinkedOpenHashSet(Collection<? extends Integer> c)
Hash.DEFAULT_LOAD_FACTOR as load
factor copying a given collection.c - a Collection to be copied into the new hash set.public IntLinkedOpenHashSet(IntCollection c, float f)
c - a type-specific collection to be copied into the new hash set.f - the load factor.public IntLinkedOpenHashSet(IntCollection c)
Hash.DEFAULT_LOAD_FACTOR as load
factor copying a given type-specific collection.c - a type-specific collection to be copied into the new hash set.public IntLinkedOpenHashSet(IntIterator i, float f)
i - a type-specific iterator whose elements will fill the set.f - the load factor.public IntLinkedOpenHashSet(IntIterator i)
Hash.DEFAULT_LOAD_FACTOR as load
factor using elements provided by a type-specific iterator.i - a type-specific iterator whose elements will fill the set.public IntLinkedOpenHashSet(Iterator<?> i, float f)
i - an iterator whose elements will fill the set.f - the load factor.public IntLinkedOpenHashSet(Iterator<?> i)
Hash.DEFAULT_LOAD_FACTOR as load
factor using elements provided by an iterator.i - an iterator whose elements will fill the set.public IntLinkedOpenHashSet(int[] a,
int offset,
int length,
float f)
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.public IntLinkedOpenHashSet(int[] a,
int offset,
int length)
Hash.DEFAULT_LOAD_FACTOR as load
factor and fills it with the elements of a given array.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.public IntLinkedOpenHashSet(int[] a,
float f)
a - an array to be copied into the new hash set.f - the load factor.public IntLinkedOpenHashSet(int[] a)
Hash.DEFAULT_LOAD_FACTOR as load
factor copying the elements of an array.a - an array to be copied into the new hash set.public boolean addAll(IntCollection c)
addAll in interface IntCollectionaddAll in class AbstractIntCollectionc - a type-specific collection.true if this collection changed as a result of the
call.Collection.addAll(Collection)public boolean addAll(Collection<? extends Integer> c)
addAll in interface Collection<Integer>addAll in interface Set<Integer>addAll in class AbstractIntCollectionc - a collection.true if this collection changed as a result of the
call.public boolean add(int k)
add in interface IntCollectionadd in class AbstractIntCollectionCollection.add(Object)public boolean rem(int k)
IntCollectionremove(), but the clash with
the similarly named index-based method in the List
interface forces us to use a distinguished name. For simplicity, the set
interfaces reinstates remove().rem in interface IntCollectionrem in class AbstractIntCollectionCollection.remove(Object)public boolean contains(int k)
contains in interface IntCollectioncontains in class AbstractIntCollectionCollection.contains(Object)public int removeFirstInt()
NoSuchElementException - is this set is empty.public int removeLastInt()
NoSuchElementException - is this set is empty.public boolean addAndMoveToFirst(int k)
k - the key.public boolean addAndMoveToLast(int k)
k - the key.public void clear()
clear in interface Collection<Integer>clear in interface Set<Integer>clear in class AbstractCollection<Integer>public int size()
size in interface Collection<Integer>size in interface Set<Integer>size in class AbstractCollection<Integer>public boolean isEmpty()
isEmpty in interface Collection<Integer>isEmpty in interface Set<Integer>isEmpty in class AbstractIntCollection@Deprecated public void growthFactor(int growthFactor)
fastutil 6.1.0, hash tables are doubled
when they are too full.growthFactor - unused.@Deprecated public int growthFactor()
fastutil 6.1.0, hash tables are doubled
when they are too full.growthFactor(int)public int firstInt()
firstInt in interface IntSortedSetSortedSet.first()public int lastInt()
lastInt in interface IntSortedSetSortedSet.last()public IntSortedSet tailSet(int from)
tailSet in interface IntSortedSetSortedSet.tailSet(Object)public IntSortedSet headSet(int to)
headSet in interface IntSortedSetSortedSet.headSet(Object)public IntSortedSet subSet(int from, int to)
subSet in interface IntSortedSetSortedSet.subSet(Object,Object)public IntComparator comparator()
IntSortedSet
Note that this specification strengthens the one given in
SortedSet.comparator().
comparator in interface IntSortedSetcomparator in interface SortedSet<Integer>SortedSet.comparator()public IntListIterator iterator(int from)
iterator in interface IntSortedSetfrom - an element to start from.IllegalArgumentException - if from does not belong to the set.public IntListIterator iterator()
IntCollection
Note that this specification strengthens the one given in
Iterable.iterator(), which was already strengthened in
the corresponding type-specific class, but was weakened by the fact that
this interface extends Collection.
iterator in interface IntCollectioniterator in interface IntIterableiterator in interface IntSetiterator in interface IntSortedSetiterator in interface Iterable<Integer>iterator in interface Collection<Integer>iterator in interface Set<Integer>iterator in class AbstractIntSortedSet@Deprecated public boolean rehash()
If you need to reduce the table size to fit exactly this set, use
trim().
trim()public boolean trim()
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.
trim(int)public boolean trim(int n)
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.
n - the threshold for the trimming.trim()public IntLinkedOpenHashSet clone()
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.
public int hashCode()
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.hashCode in interface Collection<Integer>hashCode in interface Set<Integer>hashCode in class AbstractIntSet