Class FloatLinkedOpenCustomHashSet
- java.lang.Object
-
- java.util.AbstractCollection<Float>
-
- it.unimi.dsi.fastutil.floats.AbstractFloatCollection
-
- it.unimi.dsi.fastutil.floats.AbstractFloatSet
-
- it.unimi.dsi.fastutil.floats.AbstractFloatSortedSet
-
- it.unimi.dsi.fastutil.floats.FloatLinkedOpenCustomHashSet
-
- All Implemented Interfaces:
FloatBidirectionalIterable
,FloatCollection
,FloatIterable
,FloatSet
,FloatSortedSet
,Hash
,Serializable
,Cloneable
,Iterable<Float>
,Collection<Float>
,Set<Float>
,SortedSet<Float>
public class FloatLinkedOpenCustomHashSet extends AbstractFloatSortedSet 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 FloatLinkedOpenCustomHashSet(float[] a, float f, FloatHash.Strategy strategy)
Creates a new hash set copying the elements of an array.FloatLinkedOpenCustomHashSet(float[] a, int offset, int length, float f, FloatHash.Strategy strategy)
Creates a new hash set and fills it with the elements of a given array.FloatLinkedOpenCustomHashSet(float[] a, int offset, int length, FloatHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor and fills it with the elements of a given array.FloatLinkedOpenCustomHashSet(float[] a, FloatHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.FloatLinkedOpenCustomHashSet(int expected, float f, FloatHash.Strategy strategy)
Creates a new hash set.FloatLinkedOpenCustomHashSet(int expected, FloatHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.FloatLinkedOpenCustomHashSet(FloatCollection c, float f, FloatHash.Strategy strategy)
Creates a new hash set copying a given type-specific collection.FloatLinkedOpenCustomHashSet(FloatCollection c, FloatHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific collection.FloatLinkedOpenCustomHashSet(FloatHash.Strategy strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.FloatLinkedOpenCustomHashSet(FloatIterator i, float f, FloatHash.Strategy strategy)
Creates a new hash set using elements provided by a type-specific iterator.FloatLinkedOpenCustomHashSet(FloatIterator i, FloatHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by a type-specific iterator.FloatLinkedOpenCustomHashSet(Collection<? extends Float> c, float f, FloatHash.Strategy strategy)
Creates a new hash set copying a given collection.FloatLinkedOpenCustomHashSet(Collection<? extends Float> c, FloatHash.Strategy strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.FloatLinkedOpenCustomHashSet(Iterator<?> i, float f, FloatHash.Strategy strategy)
Creates a new hash set using elements provided by an iterator.FloatLinkedOpenCustomHashSet(Iterator<?> i, FloatHash.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(float k)
Ensures that this collection contains the specified element (optional operation).boolean
addAll(FloatCollection c)
Adds all elements of the given type-specific collection to this collection.boolean
addAll(Collection<? extends Float> c)
boolean
addAndMoveToFirst(float 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(float 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()
FloatLinkedOpenCustomHashSet
clone()
Returns a deep copy of this set.FloatComparator
comparator()
boolean
contains(float k)
Returnstrue
if this collection contains the specified element.float
firstFloat()
Returns the first element of this set in iteration order.int
hashCode()
Returns a hash code for this set.FloatSortedSet
headSet(float to)
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.boolean
isEmpty()
FloatListIterator
iterator()
Returns a type-specific list iterator on the elements in this set, starting from the first element.FloatListIterator
iterator(float from)
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.float
lastFloat()
Returns the last element of this set in iteration order.boolean
remove(float k)
Removes an element from this set.float
removeFirstFloat()
Removes the first key in iteration order.float
removeLastFloat()
Removes the the last key in iteration order.int
size()
FloatHash.Strategy
strategy()
Returns the hashing strategy.FloatSortedSet
subSet(float from, float to)
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.FloatSortedSet
tailSet(float 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.floats.AbstractFloatSet
equals, rem
-
Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloatCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toFloatArray, toFloatArray, toString
-
Methods inherited from class java.util.AbstractCollection
toArray, toArray
-
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
-
Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatCollection
containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toFloatArray, toFloatArray
-
Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatIterable
forEach, forEach
-
Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatSortedSet
first, headSet, last, subSet, tailSet
-
Methods inherited from interface java.util.Set
add, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArray
-
Methods inherited from interface java.util.SortedSet
spliterator
-
-
-
-
Constructor Detail
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(int expected, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(int expected, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(Collection<? extends Float> c, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(Collection<? extends Float> c, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(FloatCollection c, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(FloatCollection c, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(FloatIterator i, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(FloatIterator i, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(Iterator<?> i, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(Iterator<?> i, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(float[] a, int offset, int length, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(float[] a, int offset, int length, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(float[] a, float f, FloatHash.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.
-
FloatLinkedOpenCustomHashSet
public FloatLinkedOpenCustomHashSet(float[] a, FloatHash.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 FloatHash.Strategy strategy()
Returns the hashing strategy.- Returns:
- the hashing strategy of this custom hash set.
-
addAll
public boolean addAll(FloatCollection c)
Description copied from interface:FloatCollection
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceFloatCollection
- Overrides:
addAll
in classAbstractFloatCollection
- 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 Float> c)
Description copied from class:AbstractFloatCollection
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<Float>
- Specified by:
addAll
in interfaceSet<Float>
- Overrides:
addAll
in classAbstractFloatCollection
-
add
public boolean add(float k)
Description copied from class:AbstractFloatCollection
Ensures that this collection contains the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
add
in interfaceFloatCollection
- Overrides:
add
in classAbstractFloatCollection
- See Also:
Collection.add(Object)
-
remove
public boolean remove(float k)
Description copied from class:AbstractFloatSet
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 interfaceFloatSet
- Overrides:
remove
in classAbstractFloatSet
- See Also:
Collection.remove(Object)
-
contains
public boolean contains(float k)
Description copied from class:AbstractFloatCollection
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 interfaceFloatCollection
- Overrides:
contains
in classAbstractFloatCollection
- See Also:
Collection.contains(Object)
-
removeFirstFloat
public float removeFirstFloat()
Removes the first key in iteration order.- Returns:
- the first key.
- Throws:
NoSuchElementException
- is this set is empty.
-
removeLastFloat
public float removeLastFloat()
Removes the the last key in iteration order.- Returns:
- the last key.
- Throws:
NoSuchElementException
- is this set is empty.
-
addAndMoveToFirst
public boolean addAndMoveToFirst(float 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(float 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<Float>
- Specified by:
clear
in interfaceSet<Float>
- Overrides:
clear
in classAbstractCollection<Float>
-
size
public int size()
- Specified by:
size
in interfaceCollection<Float>
- Specified by:
size
in interfaceSet<Float>
- Specified by:
size
in classAbstractCollection<Float>
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceCollection<Float>
- Specified by:
isEmpty
in interfaceSet<Float>
- Overrides:
isEmpty
in classAbstractCollection<Float>
-
firstFloat
public float firstFloat()
Returns the first element of this set in iteration order.- Specified by:
firstFloat
in interfaceFloatSortedSet
- Returns:
- the first element in iteration order.
- See Also:
SortedSet.first()
-
lastFloat
public float lastFloat()
Returns the last element of this set in iteration order.- Specified by:
lastFloat
in interfaceFloatSortedSet
- Returns:
- the last element in iteration order.
- See Also:
SortedSet.last()
-
tailSet
public FloatSortedSet tailSet(float 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 interfaceFloatSortedSet
- See Also:
SortedSet.tailSet(Object)
-
headSet
public FloatSortedSet headSet(float 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 interfaceFloatSortedSet
- See Also:
SortedSet.headSet(Object)
-
subSet
public FloatSortedSet subSet(float from, float 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 interfaceFloatSortedSet
- See Also:
SortedSet.subSet(Object,Object)
-
comparator
public FloatComparator comparator()
Note that this specification strengthens the one given in
SortedSet.comparator()
.This implementation just returns
null
.- Specified by:
comparator
in interfaceFloatSortedSet
- Specified by:
comparator
in interfaceSortedSet<Float>
-
iterator
public FloatListIterator iterator(float 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 interfaceFloatSortedSet
- 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 FloatListIterator 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<Float>
- Specified by:
iterator
in interfaceFloatBidirectionalIterable
- Specified by:
iterator
in interfaceFloatCollection
- Specified by:
iterator
in interfaceFloatIterable
- Specified by:
iterator
in interfaceFloatSet
- Specified by:
iterator
in interfaceFloatSortedSet
- Specified by:
iterator
in interfaceIterable<Float>
- Specified by:
iterator
in interfaceSet<Float>
- Specified by:
iterator
in classAbstractFloatSortedSet
- 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 FloatLinkedOpenCustomHashSet 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<Float>
- Specified by:
hashCode
in interfaceSet<Float>
- Overrides:
hashCode
in classAbstractFloatSet
- Returns:
- a hash code for this set.
-
-