Class ByteOpenHashSet
- All Implemented Interfaces:
it.unimi.dsi.fastutil.bytes.ByteCollection,it.unimi.dsi.fastutil.bytes.ByteIterable,ByteSet,it.unimi.dsi.fastutil.Hash,Serializable,Cloneable,Iterable<Byte>,Collection<Byte>,Set<Byte>
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
it.unimi.dsi.fastutil.Hash.Strategy<K> -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanWhether this set contains the null key.protected final floatThe acceptable load factor.protected byte[]The array of keys.protected intThe mask for wrapping a position counter.protected intThreshold after which we rehash.protected final intWe never resize below this threshold, which is the construction-time {#n}.protected intThe current table size.protected intNumber of entries in the set (including the null key, if present).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
ConstructorsConstructorDescriptionCreates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.ByteOpenHashSet(byte[] a) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying the elements of an array.ByteOpenHashSet(byte[] a, float f) Creates a new hash set copying the elements of an array.ByteOpenHashSet(byte[] a, int offset, int length) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor and fills it with the elements of a given array.ByteOpenHashSet(byte[] a, int offset, int length, float f) Creates a new hash set and fills it with the elements of a given array.ByteOpenHashSet(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.ByteOpenHashSet(int expected, float f) Creates a new hash set.ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific collection.ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c, float f) Creates a new hash set copying a given type-specific collection.ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by a type-specific iterator.ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i, float f) Creates a new hash set using elements provided by a type-specific iterator.ByteOpenHashSet(Collection<? extends Byte> c) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given collection.ByteOpenHashSet(Collection<? extends Byte> c, float f) Creates a new hash set copying a given collection.ByteOpenHashSet(Iterator<?> i) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by an iterator.ByteOpenHashSet(Iterator<?> i, float f) Creates a new hash set using elements provided by an iterator. -
Method Summary
Modifier and TypeMethodDescriptionbooleanadd(byte k) booleanaddAll(it.unimi.dsi.fastutil.bytes.ByteCollection c) booleanaddAll(Collection<? extends Byte> c) voidclear()Removes all elements from this set.clone()Returns a deep copy of this set.booleancontains(byte k) voidensureCapacity(int capacity) Ensures that this set can hold a certain number of elements without rehashing.voidforEach(it.unimi.dsi.fastutil.bytes.ByteConsumer action) inthashCode()Returns a hash code for this set.booleanisEmpty()it.unimi.dsi.fastutil.bytes.ByteIteratoriterator()Returns a type-specific iterator on the elements of this set.static ByteOpenHashSetof()Creates a new empty hash set.static ByteOpenHashSetof(byte e) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the given element.static ByteOpenHashSetof(byte... a) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using a list of elements.static ByteOpenHashSetof(byte e0, byte e1) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.static ByteOpenHashSetof(byte e0, byte e1, byte e2) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.protected voidrehash(int newN) Rehashes the set.booleanremove(byte k) Removes an element from this set.protected final voidshiftKeys(int pos) Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.intsize()it.unimi.dsi.fastutil.bytes.ByteSpliteratorReturns a type-specific spliterator on the elements of this set.booleantrim()Rehashes this set, making the table as small as possible.booleantrim(int n) Rehashes this set if the table is too large.Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteSet
equals, remMethods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toByteArray, toByteArray, toStringMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toByteArray, toByteArrayMethods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable
forEach, forEachMethods inherited from interface java.util.Collection
toArray
-
Field Details
-
key
protected transient byte[] keyThe array of keys. -
mask
protected transient int maskThe mask for wrapping a position counter. -
containsNull
protected transient boolean containsNullWhether this set contains the null key. -
n
protected transient int nThe current table size. Note that an additional element is allocated for storing the null key. -
maxFill
protected transient int maxFillThreshold after which we rehash. It must be the table size timesf. -
minN
protected final transient int minNWe never resize below this threshold, which is the construction-time {#n}. -
size
protected int sizeNumber of entries in the set (including the null key, if present). -
f
protected final float fThe acceptable load factor.
-
-
Constructor Details
-
ByteOpenHashSet
public ByteOpenHashSet(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.
-
ByteOpenHashSet
public ByteOpenHashSet(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
expected- the expected number of elements in the hash set.
-
ByteOpenHashSet
public ByteOpenHashSet()Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor. -
ByteOpenHashSet
Creates a new hash set copying a given collection.- Parameters:
c- aCollectionto be copied into the new hash set.f- the load factor.
-
ByteOpenHashSet
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given collection.- Parameters:
c- aCollectionto be copied into the new hash set.
-
ByteOpenHashSet
public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection 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.
-
ByteOpenHashSet
public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteCollection c) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific collection.- Parameters:
c- a type-specific collection to be copied into the new hash set.
-
ByteOpenHashSet
public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator 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.
-
ByteOpenHashSet
public ByteOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by a type-specific iterator.- Parameters:
i- a type-specific iterator whose elements will fill the set.
-
ByteOpenHashSet
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.
-
ByteOpenHashSet
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by an iterator.- Parameters:
i- an iterator whose elements will fill the set.
-
ByteOpenHashSet
public ByteOpenHashSet(byte[] 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.
-
ByteOpenHashSet
public ByteOpenHashSet(byte[] a, int offset, int length) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas 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.
-
ByteOpenHashSet
public ByteOpenHashSet(byte[] 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.
-
ByteOpenHashSet
public ByteOpenHashSet(byte[] a) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas 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_FACTORas 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_FACTORas load factor containinge.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.- Parameters:
e0- the first element.e1- the second element.- Returns:
- a new hash set with
Hash.DEFAULT_LOAD_FACTORas load factor containinge0ande1. - Throws:
IllegalArgumentException- if there were duplicate entries.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas 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_FACTORas load factor containinge0,e1, ande2. - Throws:
IllegalArgumentException- if there were duplicate entries.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas 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_FACTORas load factor containing the elements ofa. - Throws:
IllegalArgumentException- if a duplicate entry was encountered.
-
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
public boolean addAll(it.unimi.dsi.fastutil.bytes.ByteCollection c) - Specified by:
addAllin interfaceit.unimi.dsi.fastutil.bytes.ByteCollection- Overrides:
addAllin classit.unimi.dsi.fastutil.bytes.AbstractByteCollection
-
addAll
-
add
public boolean add(byte k) - Specified by:
addin interfaceit.unimi.dsi.fastutil.bytes.ByteCollection- Overrides:
addin classit.unimi.dsi.fastutil.bytes.AbstractByteCollection
-
shiftKeys
protected final void shiftKeys(int pos) Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.- Parameters:
pos- a starting position.
-
remove
public boolean remove(byte k) Description copied from class:AbstractByteSetRemoves an element from this set. Delegates to the type-specificrem()method implemented by type-specific abstractCollectionsuperclass.- Specified by:
removein interfaceByteSet- Overrides:
removein classAbstractByteSet- See Also:
-
contains
public boolean contains(byte k) - Specified by:
containsin interfaceit.unimi.dsi.fastutil.bytes.ByteCollection- Overrides:
containsin classit.unimi.dsi.fastutil.bytes.AbstractByteCollection
-
clear
public void clear()Removes all elements from this set.To increase object reuse, this method does not change the table size. If you want to reduce the table size, you must use
trim().- Specified by:
clearin interfaceCollection<Byte>- Specified by:
clearin interfaceSet<Byte>- Overrides:
clearin classAbstractCollection<Byte>
-
size
public int size()- Specified by:
sizein interfaceCollection<Byte>- Specified by:
sizein interfaceSet<Byte>- Specified by:
sizein classAbstractCollection<Byte>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmptyin interfaceCollection<Byte>- Specified by:
isEmptyin interfaceSet<Byte>- Overrides:
isEmptyin classAbstractCollection<Byte>
-
iterator
public it.unimi.dsi.fastutil.bytes.ByteIterator iterator()Description copied from interface:ByteSetReturns a type-specific iterator on the elements of this set.- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.bytes.ByteCollection- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.bytes.ByteIterable- Specified by:
iteratorin interfaceByteSet- Specified by:
iteratorin interfaceCollection<Byte>- Specified by:
iteratorin interfaceIterable<Byte>- Specified by:
iteratorin interfaceSet<Byte>- Specified by:
iteratorin classAbstractByteSet- Returns:
- a type-specific iterator on the elements of this set.
-
spliterator
public it.unimi.dsi.fastutil.bytes.ByteSpliterator spliterator()Description copied from interface:ByteSetReturns 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:
spliteratorin interfaceit.unimi.dsi.fastutil.bytes.ByteCollection- Specified by:
spliteratorin interfaceit.unimi.dsi.fastutil.bytes.ByteIterable- Specified by:
spliteratorin interfaceByteSet- Specified by:
spliteratorin interfaceCollection<Byte>- Specified by:
spliteratorin interfaceIterable<Byte>- Specified by:
spliteratorin interfaceSet<Byte>- Returns:
-
forEach
public void forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer action) - Specified by:
forEachin interfaceit.unimi.dsi.fastutil.bytes.ByteIterable
-
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:
-
rehash
protected void rehash(int newN) Rehashes the set.This method implements the basic rehashing strategy, and may be overriden by subclasses implementing different rehashing strategies (e.g., disk-based rehashing). However, you should not override this method unless you understand the internal workings of this class.
- Parameters:
newN- the new size
-
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.
-
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:
hashCodein interfaceCollection<Byte>- Specified by:
hashCodein interfaceSet<Byte>- Overrides:
hashCodein classAbstractByteSet- Returns:
- a hash code for this set.
-