Class ShortOpenCustomHashSet
- All Implemented Interfaces:
Hash,ShortCollection,ShortIterable,ShortSet,Serializable,Cloneable,Iterable<Short>,Collection<Short>,Set<Short>
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
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
ConstructorsConstructorDescriptionShortOpenCustomHashSet(int expected, float f, ShortHash.Strategy strategy) Creates a new hash set.ShortOpenCustomHashSet(int expected, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.ShortOpenCustomHashSet(short[] a, float f, ShortHash.Strategy strategy) Creates a new hash set copying the elements of an array.ShortOpenCustomHashSet(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.ShortOpenCustomHashSet(short[] a, int offset, int length, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor and fills it with the elements of a given array.ShortOpenCustomHashSet(short[] a, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying the elements of an array.ShortOpenCustomHashSet(ShortCollection c, float f, ShortHash.Strategy strategy) Creates a new hash set copying a given type-specific collection.ShortOpenCustomHashSet(ShortCollection c, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific collection.ShortOpenCustomHashSet(ShortHash.Strategy strategy) Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.ShortOpenCustomHashSet(ShortIterator i, float f, ShortHash.Strategy strategy) Creates a new hash set using elements provided by a type-specific iterator.ShortOpenCustomHashSet(ShortIterator i, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by a type-specific iterator.ShortOpenCustomHashSet(Collection<? extends Short> c, float f, ShortHash.Strategy strategy) Creates a new hash set copying a given collection.ShortOpenCustomHashSet(Collection<? extends Short> c, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given collection.ShortOpenCustomHashSet(Iterator<?> i, float f, ShortHash.Strategy strategy) Creates a new hash set using elements provided by an iterator.ShortOpenCustomHashSet(Iterator<?> i, ShortHash.Strategy strategy) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by an iterator. -
Method Summary
Modifier and TypeMethodDescriptionbooleanadd(short k) Ensures that this collection contains the specified element (optional operation).booleanAdds all elements of the given type-specific collection to this collection.booleanaddAll(Collection<? extends Short> c) voidclear()Removes all elements from this set.clone()Returns a deep copy of this set.booleancontains(short k) Returnstrueif this collection contains the specified element.voidensureCapacity(int capacity) Ensures that this set can hold a certain number of elements without rehashing.voidforEach(ShortConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.inthashCode()Returns a hash code for this set.booleanisEmpty()iterator()Returns a type-specific iterator on the elements of this collection.booleanremove(short k) Removes an element from this set.intsize()Returns a type-specific spliterator on the elements of this collection.strategy()Returns the hashing strategy.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.shorts.AbstractShortSet
equals, remMethods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toShortArray, toShortArray, toStringMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface it.unimi.dsi.fastutil.shorts.ShortCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toShortArray, toShortArrayMethods inherited from interface it.unimi.dsi.fastutil.shorts.ShortIterable
forEach, forEach
-
Constructor Details
-
ShortOpenCustomHashSet
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.
-
ShortOpenCustomHashSet
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
expected- the expected number of elements in the hash set.strategy- the strategy.
-
ShortOpenCustomHashSet
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
strategy- the strategy.
-
ShortOpenCustomHashSet
Creates a new hash set copying a given collection.- Parameters:
c- aCollectionto be copied into the new hash set.f- the load factor.strategy- the strategy.
-
ShortOpenCustomHashSet
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.strategy- the strategy.
-
ShortOpenCustomHashSet
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.
-
ShortOpenCustomHashSet
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.strategy- the strategy.
-
ShortOpenCustomHashSet
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.
-
ShortOpenCustomHashSet
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.strategy- the strategy.
-
ShortOpenCustomHashSet
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.
-
ShortOpenCustomHashSet
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.strategy- the strategy.
-
ShortOpenCustomHashSet
public ShortOpenCustomHashSet(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.
-
ShortOpenCustomHashSet
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.strategy- the strategy.
-
ShortOpenCustomHashSet
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.
-
ShortOpenCustomHashSet
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.strategy- the strategy.
-
-
Method Details
-
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
Description copied from interface:ShortCollectionAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceShortCollection- Overrides:
addAllin classAbstractShortCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
-
addAll
Description copied from class:AbstractShortCollection- Specified by:
addAllin interfaceCollection<Short>- Specified by:
addAllin interfaceSet<Short>- Overrides:
addAllin classAbstractShortCollection
-
add
public boolean add(short k) Description copied from class:AbstractShortCollectionEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceShortCollection- Overrides:
addin classAbstractShortCollection- See Also:
-
remove
public boolean remove(short k) Description copied from class:AbstractShortSetRemoves an element from this set. Delegates to the type-specificrem()method implemented by type-specific abstractCollectionsuperclass.- Specified by:
removein interfaceShortSet- Overrides:
removein classAbstractShortSet- See Also:
-
contains
public boolean contains(short k) Description copied from class:AbstractShortCollectionReturnstrueif this collection contains the specified element.- Specified by:
containsin interfaceShortCollection- Overrides:
containsin classAbstractShortCollection- See Also:
-
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<Short>- Specified by:
clearin interfaceSet<Short>- Overrides:
clearin classAbstractCollection<Short>
-
size
public int size()- Specified by:
sizein interfaceCollection<Short>- Specified by:
sizein interfaceSet<Short>- Specified by:
sizein classAbstractCollection<Short>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmptyin interfaceCollection<Short>- Specified by:
isEmptyin interfaceSet<Short>- Overrides:
isEmptyin classAbstractCollection<Short>
-
iterator
Description copied from interface:ShortCollectionReturns a type-specific iterator on the elements of this collection.- Specified by:
iteratorin interfaceCollection<Short>- Specified by:
iteratorin interfaceIterable<Short>- Specified by:
iteratorin interfaceSet<Short>- Specified by:
iteratorin interfaceShortCollection- Specified by:
iteratorin interfaceShortIterable- Specified by:
iteratorin interfaceShortSet- Specified by:
iteratorin classAbstractShortSet- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
-
spliterator
Description copied from interface:ShortCollectionReturns a type-specific spliterator on the elements of this collection.See
Collection.spliterator()for more documentation on the requirements of the returned spliterator.- Specified by:
spliteratorin interfaceCollection<Short>- Specified by:
spliteratorin interfaceIterable<Short>- Specified by:
spliteratorin interfaceSet<Short>- Specified by:
spliteratorin interfaceShortCollection- Specified by:
spliteratorin interfaceShortIterable- Specified by:
spliteratorin interfaceShortSet- Returns:
- a type-specific spliterator on the elements of this collection.
-
forEach
Description copied from interface:ShortIterablePerforms the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceShortIterable- Parameters:
action- the action to be performed for each element.- See Also:
-
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:
-
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 interfaceCollection<Short>- Specified by:
hashCodein interfaceSet<Short>- Overrides:
hashCodein classAbstractShortSet- Returns:
- a hash code for this set.
-