Class ShortLinkedOpenCustomHashSet
- java.lang.Object
-
- java.util.AbstractCollection<Short>
-
- it.unimi.dsi.fastutil.shorts.AbstractShortCollection
-
- it.unimi.dsi.fastutil.shorts.AbstractShortSet
-
- it.unimi.dsi.fastutil.shorts.AbstractShortSortedSet
-
- it.unimi.dsi.fastutil.shorts.ShortLinkedOpenCustomHashSet
-
- All Implemented Interfaces:
Hash
,ShortBidirectionalIterable
,ShortCollection
,ShortIterable
,ShortSet
,ShortSortedSet
,Serializable
,Cloneable
,Iterable<Short>
,Collection<Short>
,Set<Short>
,SortedSet<Short>
public class ShortLinkedOpenCustomHashSet extends AbstractShortSortedSet implements Serializable, 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 ShortLinkedOpenCustomHashSet(int expected, float f, ShortHash.Strategy strategy)
Creates a new hash set.ShortLinkedOpenCustomHashSet(int expected, ShortHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.ShortLinkedOpenCustomHashSet(short[] a, float f, ShortHash.Strategy strategy)
Creates a new hash set copying the elements of an array.ShortLinkedOpenCustomHashSet(short[] a, int offset, int length, float f, ShortHash.Strategy strategy)
Creates a new hash set and fills it with the elements of a given array.ShortLinkedOpenCustomHashSet(short[] a, int offset, int length, ShortHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor and fills it with the elements of a given array.ShortLinkedOpenCustomHashSet(short[] a, ShortHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.ShortLinkedOpenCustomHashSet(ShortCollection c, float f, ShortHash.Strategy strategy)
Creates a new hash set copying a given type-specific collection.ShortLinkedOpenCustomHashSet(ShortCollection c, ShortHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific collection.ShortLinkedOpenCustomHashSet(ShortHash.Strategy strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.ShortLinkedOpenCustomHashSet(ShortIterator i, float f, ShortHash.Strategy strategy)
Creates a new hash set using elements provided by a type-specific iterator.ShortLinkedOpenCustomHashSet(ShortIterator i, ShortHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by a type-specific iterator.ShortLinkedOpenCustomHashSet(Collection<? extends Short> c, float f, ShortHash.Strategy strategy)
Creates a new hash set copying a given collection.ShortLinkedOpenCustomHashSet(Collection<? extends Short> c, ShortHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.ShortLinkedOpenCustomHashSet(Iterator<?> i, float f, ShortHash.Strategy strategy)
Creates a new hash set using elements provided by an iterator.ShortLinkedOpenCustomHashSet(Iterator<?> i, ShortHash.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(short k)
Ensures that this collection contains the specified element (optional operation).boolean
addAll(ShortCollection c)
Adds all elements of the given type-specific collection to this collection.boolean
addAll(Collection<? extends Short> c)
boolean
addAndMoveToFirst(short 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(short 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()
ShortLinkedOpenCustomHashSet
clone()
Returns a deep copy of this set.ShortComparator
comparator()
boolean
contains(short k)
Returnstrue
if this collection contains the specified element.short
firstShort()
Returns the first element of this set in iteration order.int
hashCode()
Returns a hash code for this set.ShortSortedSet
headSet(short to)
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.boolean
isEmpty()
ShortListIterator
iterator()
Returns a type-specific list iterator on the elements in this set, starting from the first element.ShortListIterator
iterator(short from)
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.short
lastShort()
Returns the last element of this set in iteration order.boolean
remove(short k)
Removes an element from this set.short
removeFirstShort()
Removes the first key in iteration order.short
removeLastShort()
Removes the the last key in iteration order.int
size()
ShortHash.Strategy
strategy()
Returns the hashing strategy.ShortSortedSet
subSet(short from, short to)
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.ShortSortedSet
tailSet(short 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.shorts.AbstractShortSet
equals, rem
-
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toShortArray, toShortArray, toString
-
Methods inherited from class java.util.AbstractCollection
toArray, toArray
-
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
-
Methods inherited from interface java.util.Set
add, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArray
-
Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortCollection
containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toShortArray, toShortArray
-
Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortIterable
forEach, forEach
-
Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortSortedSet
first, headSet, last, subSet, tailSet
-
Methods inherited from interface java.util.SortedSet
spliterator
-
-
-
-
Constructor Detail
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(int expected, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(int expected, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(Collection<? extends Short> c, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(Collection<? extends Short> c, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(ShortCollection c, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(ShortCollection c, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(ShortIterator i, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(ShortIterator i, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(Iterator<?> i, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(Iterator<?> i, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(short[] a, int offset, int length, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(short[] a, int offset, int length, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(short[] a, float f, ShortHash.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.
-
ShortLinkedOpenCustomHashSet
public ShortLinkedOpenCustomHashSet(short[] a, ShortHash.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 ShortHash.Strategy strategy()
Returns the hashing strategy.- Returns:
- the hashing strategy of this custom hash set.
-
addAll
public boolean addAll(ShortCollection c)
Description copied from interface:ShortCollection
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceShortCollection
- Overrides:
addAll
in classAbstractShortCollection
- 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(Collection<? extends Short> c)
Description copied from class:AbstractShortCollection
This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from
AbstractCollection
.- Specified by:
addAll
in interfaceCollection<Short>
- Specified by:
addAll
in interfaceSet<Short>
- Overrides:
addAll
in classAbstractShortCollection
-
add
public boolean add(short k)
Description copied from class:AbstractShortCollection
Ensures that this collection contains the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
add
in interfaceShortCollection
- Overrides:
add
in classAbstractShortCollection
- See Also:
Collection.add(Object)
-
remove
public boolean remove(short k)
Description copied from class:AbstractShortSet
Removes an element from this set.Note that the corresponding method of a type-specific collection is
rem()
. This unfortunate situation is caused by the clash with the similarly named index-based method in theList
interface. Delegates to the type-specificrem()
method implemented by type-specific abstractCollection
superclass.- Specified by:
remove
in interfaceShortSet
- Overrides:
remove
in classAbstractShortSet
- See Also:
Collection.remove(Object)
-
contains
public boolean contains(short k)
Description copied from class:AbstractShortCollection
Returnstrue
if this collection contains the specified element.This implementation iterates over the elements in the collection, looking for the specified element.
- Specified by:
contains
in interfaceShortCollection
- Overrides:
contains
in classAbstractShortCollection
- See Also:
Collection.contains(Object)
-
removeFirstShort
public short removeFirstShort()
Removes the first key in iteration order.- Returns:
- the first key.
- Throws:
NoSuchElementException
- is this set is empty.
-
removeLastShort
public short removeLastShort()
Removes the the last key in iteration order.- Returns:
- the last key.
- Throws:
NoSuchElementException
- is this set is empty.
-
addAndMoveToFirst
public boolean addAndMoveToFirst(short 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(short 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<Short>
- Specified by:
clear
in interfaceSet<Short>
- Overrides:
clear
in classAbstractCollection<Short>
-
size
public int size()
- Specified by:
size
in interfaceCollection<Short>
- Specified by:
size
in interfaceSet<Short>
- Specified by:
size
in classAbstractCollection<Short>
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceCollection<Short>
- Specified by:
isEmpty
in interfaceSet<Short>
- Overrides:
isEmpty
in classAbstractCollection<Short>
-
firstShort
public short firstShort()
Returns the first element of this set in iteration order.- Specified by:
firstShort
in interfaceShortSortedSet
- Returns:
- the first element in iteration order.
- See Also:
SortedSet.first()
-
lastShort
public short lastShort()
Returns the last element of this set in iteration order.- Specified by:
lastShort
in interfaceShortSortedSet
- Returns:
- the last element in iteration order.
- See Also:
SortedSet.last()
-
tailSet
public ShortSortedSet tailSet(short from)
Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement
.Note that this specification strengthens the one given in
SortedSet.headSet(Object)
.This implementation just throws an
UnsupportedOperationException
.- Specified by:
tailSet
in interfaceShortSortedSet
- See Also:
SortedSet.tailSet(Object)
-
headSet
public ShortSortedSet headSet(short to)
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.Note that this specification strengthens the one given in
SortedSet.headSet(Object)
.This implementation just throws an
UnsupportedOperationException
.- Specified by:
headSet
in interfaceShortSortedSet
- See Also:
SortedSet.headSet(Object)
-
subSet
public ShortSortedSet subSet(short from, short to)
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.Note that this specification strengthens the one given in
SortedSet.subSet(Object,Object)
.This implementation just throws an
UnsupportedOperationException
.- Specified by:
subSet
in interfaceShortSortedSet
- See Also:
SortedSet.subSet(Object,Object)
-
comparator
public ShortComparator comparator()
Note that this specification strengthens the one given in
SortedSet.comparator()
.This implementation just returns
null
.- Specified by:
comparator
in interfaceShortSortedSet
- Specified by:
comparator
in interfaceSortedSet<Short>
-
iterator
public ShortListIterator iterator(short 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 interfaceShortSortedSet
- 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
public ShortListIterator 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<Short>
- Specified by:
iterator
in interfaceIterable<Short>
- Specified by:
iterator
in interfaceSet<Short>
- Specified by:
iterator
in interfaceShortBidirectionalIterable
- Specified by:
iterator
in interfaceShortCollection
- Specified by:
iterator
in interfaceShortIterable
- Specified by:
iterator
in interfaceShortSet
- Specified by:
iterator
in interfaceShortSortedSet
- Specified by:
iterator
in classAbstractShortSortedSet
- Returns:
- a type-specific list iterator starting at the first element.
- See Also:
Iterable.iterator()
-
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 ShortLinkedOpenCustomHashSet 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<Short>
- Specified by:
hashCode
in interfaceSet<Short>
- Overrides:
hashCode
in classAbstractShortSet
- Returns:
- a hash code for this set.
-
-