Class ByteLinkedOpenHashSet
- All Implemented Interfaces:
ByteBidirectionalIterable,ByteCollection,it.unimi.dsi.fastutil.bytes.ByteIterable,ByteSet,ByteSortedSet,it.unimi.dsi.fastutil.Hash,java.io.Serializable,java.lang.Cloneable,java.lang.Iterable<java.lang.Byte>,java.util.Collection<java.lang.Byte>,java.util.Set<java.lang.Byte>,java.util.SortedSet<java.lang.Byte>
public class ByteLinkedOpenHashSet extends AbstractByteSortedSet implements java.io.Serializable, java.lang.Cloneable, it.unimi.dsi.fastutil.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, 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:
Hash,HashCommon, Serialized Form
-
Nested Class Summary
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
it.unimi.dsi.fastutil.Hash.Strategy<K extends java.lang.Object> -
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
Constructors Constructor Description ByteLinkedOpenHashSet()Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.ByteLinkedOpenHashSet(byte[] a)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying the elements of an array.ByteLinkedOpenHashSet(byte[] a, float f)Creates a new hash set copying the elements of an array.ByteLinkedOpenHashSet(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.ByteLinkedOpenHashSet(byte[] a, int offset, int length, float f)Creates a new hash set and fills it with the elements of a given array.ByteLinkedOpenHashSet(int expected)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.ByteLinkedOpenHashSet(int expected, float f)Creates a new hash set.ByteLinkedOpenHashSet(ByteCollection c)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific collection.ByteLinkedOpenHashSet(ByteCollection c, float f)Creates a new hash set copying a given type-specific collection.ByteLinkedOpenHashSet(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.ByteLinkedOpenHashSet(it.unimi.dsi.fastutil.bytes.ByteIterator i, float f)Creates a new hash set using elements provided by a type-specific iterator.ByteLinkedOpenHashSet(java.util.Collection<? extends java.lang.Byte> c)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given collection.ByteLinkedOpenHashSet(java.util.Collection<? extends java.lang.Byte> c, float f)Creates a new hash set copying a given collection.ByteLinkedOpenHashSet(java.util.Iterator<?> i)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by an iterator.ByteLinkedOpenHashSet(java.util.Iterator<?> i, float f)Creates a new hash set using elements provided by an iterator. -
Method Summary
Modifier and Type Method Description booleanadd(byte k)Ensures that this collection contains the specified element (optional operation).booleanaddAll(ByteCollection c)Adds all elements of the given type-specific collection to this collection.booleanaddAll(java.util.Collection<? extends java.lang.Byte> c)booleanaddAndMoveToFirst(byte k)Adds a key to the set; if the key is already present, it is moved to the first position of the iteration order.booleanaddAndMoveToLast(byte k)Adds a key to the set; if the key is already present, it is moved to the last position of the iteration order.voidclear()ByteLinkedOpenHashSetclone()Returns a deep copy of this set.ByteComparatorcomparator()booleancontains(byte k)Returnstrueif this collection contains the specified element.bytefirstByte()Returns the first element of this set in iteration order.voidforEach(ByteConsumer action)inthashCode()Returns a hash code for this set.ByteSortedSetheadSet(byte to)Returns a view of the portion of this sorted set whose elements are strictly less thantoElement.booleanisEmpty()ByteListIteratoriterator()Returns a type-specific list iterator on the elements in this set, starting from the first element.ByteListIteratoriterator(byte from)Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.bytelastByte()Returns the last element of this set in iteration order.static ByteLinkedOpenHashSetof()Creates a new empty hash set.static ByteLinkedOpenHashSetof(byte e)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the given element.static ByteLinkedOpenHashSetof(byte... a)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using a list of elements.static ByteLinkedOpenHashSetof(byte e0, byte e1)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.static ByteLinkedOpenHashSetof(byte e0, byte e1, byte e2)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.booleanremove(byte k)Removes an element from this set.byteremoveFirstByte()Removes the first key in iteration order.byteremoveLastByte()Removes the the last key in iteration order.intsize()it.unimi.dsi.fastutil.bytes.ByteSpliteratorspliterator()Returns a type-specific spliterator on the elements of this sorted-set.ByteSortedSetsubSet(byte from, byte to)Returns a view of the portion of this sorted set whose elements range fromfromElement, inclusive, totoElement, exclusive.ByteSortedSettailSet(byte from)Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement.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
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 it.unimi.dsi.fastutil.bytes.ByteSortedSet
first, headSet, last, subSet, tailSetMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface java.util.Set
add, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArray
-
Constructor Details
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(int expected)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
expected- the expected number of elements in the hash set.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet()Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor. -
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(java.util.Collection<? extends java.lang.Byte> c, float f)Creates a new hash set copying a given collection.- Parameters:
c- aCollectionto be copied into the new hash set.f- the load factor.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(java.util.Collection<? extends java.lang.Byte> c)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.
-
ByteLinkedOpenHashSet
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.
-
ByteLinkedOpenHashSet
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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(java.util.Iterator<?> i, float f)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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(java.util.Iterator<?> i)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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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.
-
ByteLinkedOpenHashSet
public ByteLinkedOpenHashSet(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:
java.lang.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:
java.lang.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:
java.lang.IllegalArgumentException- if a duplicate entry was encountered.
-
addAll
Description copied from interface:ByteCollectionAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceByteCollection- Overrides:
addAllin classAbstractByteCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
Collection.addAll(Collection)
-
addAll
public boolean addAll(java.util.Collection<? extends java.lang.Byte> c)Description copied from class:AbstractByteCollection- Specified by:
addAllin interfacejava.util.Collection<java.lang.Byte>- Specified by:
addAllin interfacejava.util.Set<java.lang.Byte>- Overrides:
addAllin classAbstractByteCollection
-
add
public boolean add(byte k)Description copied from class:AbstractByteCollectionEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceByteCollection- Overrides:
addin classAbstractByteCollection- See Also:
Collection.add(Object)
-
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:
Collection.remove(Object)
-
contains
public boolean contains(byte k)Description copied from class:AbstractByteCollectionReturnstrueif this collection contains the specified element.- Specified by:
containsin interfaceByteCollection- Overrides:
containsin classAbstractByteCollection- See Also:
Collection.contains(Object)
-
removeFirstByte
public byte removeFirstByte()Removes the first key in iteration order.- Returns:
- the first key.
- Throws:
java.util.NoSuchElementException- is this set is empty.
-
removeLastByte
public byte removeLastByte()Removes the the last key in iteration order.- Returns:
- the last key.
- Throws:
java.util.NoSuchElementException- is this set is empty.
-
addAndMoveToFirst
public boolean addAndMoveToFirst(byte 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(byte 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:
clearin interfacejava.util.Collection<java.lang.Byte>- Specified by:
clearin interfacejava.util.Set<java.lang.Byte>- Overrides:
clearin classjava.util.AbstractCollection<java.lang.Byte>
-
size
public int size()- Specified by:
sizein interfacejava.util.Collection<java.lang.Byte>- Specified by:
sizein interfacejava.util.Set<java.lang.Byte>- Specified by:
sizein classjava.util.AbstractCollection<java.lang.Byte>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmptyin interfacejava.util.Collection<java.lang.Byte>- Specified by:
isEmptyin interfacejava.util.Set<java.lang.Byte>- Overrides:
isEmptyin classjava.util.AbstractCollection<java.lang.Byte>
-
firstByte
public byte firstByte()Returns the first element of this set in iteration order.- Specified by:
firstBytein interfaceByteSortedSet- Returns:
- the first element in iteration order.
- See Also:
SortedSet.first()
-
lastByte
public byte lastByte()Returns the last element of this set in iteration order.- Specified by:
lastBytein interfaceByteSortedSet- Returns:
- the last element in iteration order.
- See Also:
SortedSet.last()
-
tailSet
Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement.- Specified by:
tailSetin interfaceByteSortedSet- See Also:
SortedSet.tailSet(Object)- 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:
headSetin interfaceByteSortedSet- See Also:
SortedSet.headSet(Object)- 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:
subSetin interfaceByteSortedSet- See Also:
SortedSet.subSet(Object,Object)- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException.
-
comparator
- Specified by:
comparatorin interfaceByteSortedSet- Specified by:
comparatorin interfacejava.util.SortedSet<java.lang.Byte>- 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:
iteratorin interfaceByteSortedSet- Parameters:
from- an element to start from.- Returns:
- a type-specific list iterator starting at the given element.
- Throws:
java.lang.IllegalArgumentException- iffromdoes 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:
iteratorin interfaceByteBidirectionalIterable- Specified by:
iteratorin interfaceByteCollection- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.bytes.ByteIterable- Specified by:
iteratorin interfaceByteSet- Specified by:
iteratorin interfaceByteSortedSet- Specified by:
iteratorin interfacejava.util.Collection<java.lang.Byte>- Specified by:
iteratorin interfacejava.lang.Iterable<java.lang.Byte>- Specified by:
iteratorin interfacejava.util.Set<java.lang.Byte>- Specified by:
iteratorin classAbstractByteSortedSet- Returns:
- a type-specific list iterator starting at the first element.
-
spliterator
public it.unimi.dsi.fastutil.bytes.ByteSpliterator 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'sByteSortedSet.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:
spliteratorin interfaceByteCollection- Specified by:
spliteratorin interfaceit.unimi.dsi.fastutil.bytes.ByteIterable- Specified by:
spliteratorin interfaceByteSet- Specified by:
spliteratorin interfaceByteSortedSet- Specified by:
spliteratorin interfacejava.util.Collection<java.lang.Byte>- Specified by:
spliteratorin interfacejava.lang.Iterable<java.lang.Byte>- Specified by:
spliteratorin interfacejava.util.Set<java.lang.Byte>- Specified by:
spliteratorin interfacejava.util.SortedSet<java.lang.Byte>- Returns:
- a type-specific spliterator on the elements of this collection.
-
forEach
- 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(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,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:
trim()
-
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:
hashCodein interfacejava.util.Collection<java.lang.Byte>- Specified by:
hashCodein interfacejava.util.Set<java.lang.Byte>- Overrides:
hashCodein classAbstractByteSet- Returns:
- a hash code for this set.
-