Class ByteLinkedOpenCustomHashSet
- java.lang.Object
-
- java.util.AbstractCollection<java.lang.Byte>
-
- it.unimi.dsi.fastutil.bytes.AbstractByteCollection
-
- it.unimi.dsi.fastutil.bytes.AbstractByteSet
-
- it.unimi.dsi.fastutil.bytes.AbstractByteSortedSet
-
- it.unimi.dsi.fastutil.bytes.ByteLinkedOpenCustomHashSet
-
- All Implemented Interfaces:
ByteBidirectionalIterable
,ByteCollection
,ByteIterable
,ByteSet
,ByteSortedSet
,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 ByteLinkedOpenCustomHashSet extends AbstractByteSortedSet implements java.io.Serializable, java.lang.Cloneable, Hash
A type-specific linked hash set with with a fast, small-footprint implementation.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 theSortedSet
contract because all subset methods throw an exception andcomparator()
returns alwaysnull
.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-specificBidirectionalIterator
, 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
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
Constructors Constructor Description ByteLinkedOpenCustomHashSet(byte[] a, float f, ByteHash.Strategy strategy)
Creates a new hash set copying the elements of an array.ByteLinkedOpenCustomHashSet(byte[] a, int offset, int length, float f, ByteHash.Strategy strategy)
Creates a new hash set and fills it with the elements of a given array.ByteLinkedOpenCustomHashSet(byte[] a, int offset, int length, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor and fills it with the elements of a given array.ByteLinkedOpenCustomHashSet(byte[] a, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.ByteLinkedOpenCustomHashSet(int expected, float f, ByteHash.Strategy strategy)
Creates a new hash set.ByteLinkedOpenCustomHashSet(int expected, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.ByteLinkedOpenCustomHashSet(ByteCollection c, float f, ByteHash.Strategy strategy)
Creates a new hash set copying a given type-specific collection.ByteLinkedOpenCustomHashSet(ByteCollection c, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific collection.ByteLinkedOpenCustomHashSet(ByteHash.Strategy strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.ByteLinkedOpenCustomHashSet(ByteIterator i, float f, ByteHash.Strategy strategy)
Creates a new hash set using elements provided by a type-specific iterator.ByteLinkedOpenCustomHashSet(ByteIterator i, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by a type-specific iterator.ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> c, float f, ByteHash.Strategy strategy)
Creates a new hash set copying a given collection.ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> c, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.ByteLinkedOpenCustomHashSet(java.util.Iterator<?> i, float f, ByteHash.Strategy strategy)
Creates a new hash set using elements provided by an iterator.ByteLinkedOpenCustomHashSet(java.util.Iterator<?> i, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by an iterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(byte k)
Ensures that this collection contains the specified element (optional operation).boolean
addAll(ByteCollection c)
Adds all elements of the given type-specific collection to this collection.boolean
addAll(java.util.Collection<? extends java.lang.Byte> c)
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.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.void
clear()
ByteLinkedOpenCustomHashSet
clone()
Returns a deep copy of this set.ByteComparator
comparator()
boolean
contains(byte 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.byte
firstByte()
Returns the first element of this set in iteration order.void
forEach(ByteConsumer 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.ByteSortedSet
headSet(byte to)
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.boolean
isEmpty()
ByteListIterator
iterator()
Returns a type-specific list iterator on the elements in this set, starting from the first element.ByteListIterator
iterator(byte from)
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.byte
lastByte()
Returns the last element of this set in iteration order.boolean
remove(byte k)
Removes an element from this set.byte
removeFirstByte()
Removes the first key in iteration order.byte
removeLastByte()
Removes the the last key in iteration order.int
size()
ByteSpliterator
spliterator()
Returns a type-specific spliterator on the elements of this sorted-set.ByteHash.Strategy
strategy()
Returns the hashing strategy.ByteSortedSet
subSet(byte from, byte to)
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.ByteSortedSet
tailSet(byte from)
Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement
.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.bytes.AbstractByteSet
equals, rem
-
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toByteArray, toByteArray, toString
-
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toByteArray, toByteArray
-
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable
forEach, forEach
-
-
-
-
Constructor Detail
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(int expected, float f, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(int expected, ByteHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
expected
- the expected number of elements in the hash set.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(ByteHash.Strategy strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> c, float f, ByteHash.Strategy strategy)
Creates a new hash set copying a given collection.- Parameters:
c
- aCollection
to be copied into the new hash set.f
- the load factor.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(java.util.Collection<? extends java.lang.Byte> c, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(ByteCollection c, float f, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(ByteCollection c, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(ByteIterator i, float f, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(ByteIterator i, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(java.util.Iterator<?> i, float f, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(java.util.Iterator<?> i, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(byte[] a, int offset, int length, float f, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(byte[] a, int offset, int length, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(byte[] a, float f, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
ByteLinkedOpenCustomHashSet
public ByteLinkedOpenCustomHashSet(byte[] a, ByteHash.Strategy strategy)
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.strategy
- the strategy.
-
-
Method Detail
-
strategy
public ByteHash.Strategy strategy()
Returns the hashing strategy.- Returns:
- the hashing strategy of this custom hash set.
-
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(ByteCollection c)
Description copied from interface:ByteCollection
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceByteCollection
- Overrides:
addAll
in classAbstractByteCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if 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:
addAll
in interfacejava.util.Collection<java.lang.Byte>
- Specified by:
addAll
in interfacejava.util.Set<java.lang.Byte>
- Overrides:
addAll
in classAbstractByteCollection
-
add
public boolean add(byte k)
Description copied from class:AbstractByteCollection
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceByteCollection
- Overrides:
add
in classAbstractByteCollection
- See Also:
Collection.add(Object)
-
remove
public boolean remove(byte k)
Description copied from class:AbstractByteSet
Removes an element from this set. Delegates to the type-specificrem()
method implemented by type-specific abstractCollection
superclass.- Specified by:
remove
in interfaceByteSet
- Overrides:
remove
in classAbstractByteSet
- See Also:
Collection.remove(Object)
-
contains
public boolean contains(byte k)
Description copied from class:AbstractByteCollection
Returnstrue
if this collection contains the specified element.- Specified by:
contains
in interfaceByteCollection
- Overrides:
contains
in 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:
clear
in interfacejava.util.Collection<java.lang.Byte>
- Specified by:
clear
in interfacejava.util.Set<java.lang.Byte>
- Overrides:
clear
in classjava.util.AbstractCollection<java.lang.Byte>
-
size
public int size()
- Specified by:
size
in interfacejava.util.Collection<java.lang.Byte>
- Specified by:
size
in interfacejava.util.Set<java.lang.Byte>
- Specified by:
size
in classjava.util.AbstractCollection<java.lang.Byte>
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfacejava.util.Collection<java.lang.Byte>
- Specified by:
isEmpty
in interfacejava.util.Set<java.lang.Byte>
- Overrides:
isEmpty
in classjava.util.AbstractCollection<java.lang.Byte>
-
firstByte
public byte firstByte()
Returns the first element of this set in iteration order.- Specified by:
firstByte
in 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:
lastByte
in interfaceByteSortedSet
- Returns:
- the last element in iteration order.
- See Also:
SortedSet.last()
-
tailSet
public ByteSortedSet tailSet(byte from)
Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement
.- Specified by:
tailSet
in interfaceByteSortedSet
- See Also:
SortedSet.tailSet(Object)
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
headSet
public ByteSortedSet headSet(byte to)
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.- Specified by:
headSet
in interfaceByteSortedSet
- See Also:
SortedSet.headSet(Object)
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
subSet
public ByteSortedSet subSet(byte from, byte to)
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.- Specified by:
subSet
in interfaceByteSortedSet
- See Also:
SortedSet.subSet(Object,Object)
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
comparator
public ByteComparator comparator()
- Specified by:
comparator
in interfaceByteSortedSet
- Specified by:
comparator
in interfacejava.util.SortedSet<java.lang.Byte>
- Implementation Specification:
- This implementation just returns
null
.
-
iterator
public ByteListIterator iterator(byte from)
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 interfaceByteSortedSet
- Parameters:
from
- an element to start from.- Returns:
- a type-specific list iterator starting at the given element.
- Throws:
java.lang.IllegalArgumentException
- iffrom
does not belong to the set.
-
iterator
public ByteListIterator 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 interfaceByteBidirectionalIterable
- Specified by:
iterator
in interfaceByteCollection
- Specified by:
iterator
in interfaceByteIterable
- Specified by:
iterator
in interfaceByteSet
- Specified by:
iterator
in interfaceByteSortedSet
- Specified by:
iterator
in interfacejava.util.Collection<java.lang.Byte>
- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.Byte>
- Specified by:
iterator
in interfacejava.util.Set<java.lang.Byte>
- Specified by:
iterator
in classAbstractByteSortedSet
- Returns:
- a type-specific list iterator starting at the first element.
- See Also:
Iterable.iterator()
-
spliterator
public 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:
spliterator
in interfaceByteCollection
- Specified by:
spliterator
in interfaceByteIterable
- Specified by:
spliterator
in interfaceByteSet
- Specified by:
spliterator
in interfaceByteSortedSet
- Specified by:
spliterator
in interfacejava.util.Collection<java.lang.Byte>
- Specified by:
spliterator
in interfacejava.lang.Iterable<java.lang.Byte>
- Specified by:
spliterator
in interfacejava.util.Set<java.lang.Byte>
- Specified by:
spliterator
in interfacejava.util.SortedSet<java.lang.Byte>
- Returns:
- a type-specific spliterator on the elements of this collection.
-
forEach
public void forEach(ByteConsumer action)
Description copied from interface:ByteIterable
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 interfaceByteIterable
- Parameters:
action
- the action to be performed for each element.- See Also:
Iterable.forEach(java.util.function.Consumer)
-
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
public ByteLinkedOpenCustomHashSet 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 interfacejava.util.Collection<java.lang.Byte>
- Specified by:
hashCode
in interfacejava.util.Set<java.lang.Byte>
- Overrides:
hashCode
in classAbstractByteSet
- Returns:
- a hash code for this set.
-
-