Class ObjectLinkedOpenCustomHashSet<K>
- java.lang.Object
-
- java.util.AbstractCollection<K>
-
- it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
-
- it.unimi.dsi.fastutil.objects.AbstractObjectSet<K>
-
- it.unimi.dsi.fastutil.objects.AbstractObjectSortedSet<K>
-
- it.unimi.dsi.fastutil.objects.ObjectLinkedOpenCustomHashSet<K>
-
- All Implemented Interfaces:
Hash
,ObjectBidirectionalIterable<K>
,ObjectCollection<K>
,ObjectIterable<K>
,ObjectSet<K>
,ObjectSortedSet<K>
,java.io.Serializable
,java.lang.Cloneable
,java.lang.Iterable<K>
,java.util.Collection<K>
,java.util.Set<K>
,java.util.SortedSet<K>
public class ObjectLinkedOpenCustomHashSet<K> extends AbstractObjectSortedSet<K> 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 ObjectLinkedOpenCustomHashSet(int expected, float f, Hash.Strategy<? super K> strategy)
Creates a new hash set.ObjectLinkedOpenCustomHashSet(int expected, Hash.Strategy<? super K> strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor.ObjectLinkedOpenCustomHashSet(Hash.Strategy<? super K> strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.ObjectLinkedOpenCustomHashSet(ObjectCollection<? extends K> c, float f, Hash.Strategy<? super K> strategy)
Creates a new hash set copying a given type-specific collection.ObjectLinkedOpenCustomHashSet(ObjectCollection<? extends K> c, Hash.Strategy<? super K> strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific collection.ObjectLinkedOpenCustomHashSet(java.util.Collection<? extends K> c, float f, Hash.Strategy<? super K> strategy)
Creates a new hash set copying a given collection.ObjectLinkedOpenCustomHashSet(java.util.Collection<? extends K> c, Hash.Strategy<? super K> strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.ObjectLinkedOpenCustomHashSet(java.util.Iterator<? extends K> i, float f, Hash.Strategy<? super K> strategy)
Creates a new hash set using elements provided by a type-specific iterator.ObjectLinkedOpenCustomHashSet(java.util.Iterator<? extends K> i, Hash.Strategy<? super K> strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by a type-specific iterator.ObjectLinkedOpenCustomHashSet(K[] a, float f, Hash.Strategy<? super K> strategy)
Creates a new hash set copying the elements of an array.ObjectLinkedOpenCustomHashSet(K[] a, int offset, int length, float f, Hash.Strategy<? super K> strategy)
Creates a new hash set and fills it with the elements of a given array.ObjectLinkedOpenCustomHashSet(K[] a, int offset, int length, Hash.Strategy<? super K> strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor and fills it with the elements of a given array.ObjectLinkedOpenCustomHashSet(K[] a, Hash.Strategy<? super K> strategy)
Creates a new hash set withHash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(K k)
boolean
addAll(java.util.Collection<? extends K> c)
boolean
addAndMoveToFirst(K 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(K k)
Adds a key to the set; if the key is already present, it is moved to the last position of the iteration order.K
addOrGet(K k)
Add a random element if not present, get the existing value if already present.void
clear()
ObjectLinkedOpenCustomHashSet<K>
clone()
Returns a deep copy of this set.java.util.Comparator<? super K>
comparator()
boolean
contains(java.lang.Object k)
K
first()
Returns the first element of this set in iteration order.K
get(java.lang.Object k)
Returns the element of this set that is equal to the given key, ornull
.int
hashCode()
Returns a hash code for this set.ObjectSortedSet<K>
headSet(K to)
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement
.boolean
isEmpty()
ObjectListIterator<K>
iterator()
Returns a type-specific list iterator on the elements in this set, starting from the first element.ObjectListIterator<K>
iterator(K from)
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.K
last()
Returns the last element of this set in iteration order.boolean
remove(java.lang.Object k)
K
removeFirst()
Removes the first key in iteration order.K
removeLast()
Removes the the last key in iteration order.int
size()
Hash.Strategy<? super K>
strategy()
Returns the hashing strategy.ObjectSortedSet<K>
subSet(K from, K to)
Returns a view of the portion of this sorted set whose elements range fromfromElement
, inclusive, totoElement
, exclusive.ObjectSortedSet<K>
tailSet(K 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.objects.AbstractObjectSet
equals
-
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectCollection
toString
-
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toArray, toArray
-
-
-
-
Constructor Detail
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(int expected, float f, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(int expected, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(Hash.Strategy<? super K> strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZE
elements andHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
strategy
- the strategy.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(java.util.Collection<? extends K> c, float f, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(java.util.Collection<? extends K> c, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(ObjectCollection<? extends K> c, float f, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(ObjectCollection<? extends K> c, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(java.util.Iterator<? extends K> i, float f, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(java.util.Iterator<? extends K> i, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(K[] a, int offset, int length, float f, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(K[] a, int offset, int length, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(K[] a, float f, Hash.Strategy<? super K> 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.
-
ObjectLinkedOpenCustomHashSet
public ObjectLinkedOpenCustomHashSet(K[] a, Hash.Strategy<? super K> 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 Hash.Strategy<? super K> strategy()
Returns the hashing strategy.- Returns:
- the hashing strategy of this custom hash set.
-
addAll
public boolean addAll(java.util.Collection<? extends K> c)
-
add
public boolean add(K k)
-
addOrGet
public K addOrGet(K k)
Add a random element if not present, get the existing value if already present. This is equivalent to (but faster than) doing a:K exist = set.get(k); if (exist == null) { set.add(k); exist = k; }
-
remove
public boolean remove(java.lang.Object k)
-
contains
public boolean contains(java.lang.Object k)
-
get
public K get(java.lang.Object k)
Returns the element of this set that is equal to the given key, ornull
.- Returns:
- the element of this set that is equal to the given key, or
null
.
-
removeFirst
public K removeFirst()
Removes the first key in iteration order.- Returns:
- the first key.
- Throws:
java.util.NoSuchElementException
- is this set is empty.
-
removeLast
public K removeLast()
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(K 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(K 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()
-
size
public int size()
-
isEmpty
public boolean isEmpty()
-
first
public K first()
Returns the first element of this set in iteration order.- Specified by:
first
in interfacejava.util.SortedSet<K>
- Returns:
- the first element in iteration order.
-
last
public K last()
Returns the last element of this set in iteration order.- Specified by:
last
in interfacejava.util.SortedSet<K>
- Returns:
- the last element in iteration order.
-
tailSet
public ObjectSortedSet<K> tailSet(K 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 interfaceObjectSortedSet<K>
- Specified by:
tailSet
in interfacejava.util.SortedSet<K>
- See Also:
SortedSet.tailSet(Object)
-
headSet
public ObjectSortedSet<K> headSet(K 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 interfaceObjectSortedSet<K>
- Specified by:
headSet
in interfacejava.util.SortedSet<K>
- See Also:
SortedSet.headSet(Object)
-
subSet
public ObjectSortedSet<K> subSet(K from, K 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 interfaceObjectSortedSet<K>
- Specified by:
subSet
in interfacejava.util.SortedSet<K>
- See Also:
SortedSet.subSet(Object,Object)
-
comparator
public java.util.Comparator<? super K> comparator()
This implementation just returns
null
.- Specified by:
comparator
in interfacejava.util.SortedSet<K>
-
iterator
public ObjectListIterator<K> iterator(K 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 interfaceObjectSortedSet<K>
- 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 ObjectListIterator<K> 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 interfacejava.util.Collection<K>
- Specified by:
iterator
in interfacejava.lang.Iterable<K>
- Specified by:
iterator
in interfaceObjectBidirectionalIterable<K>
- Specified by:
iterator
in interfaceObjectCollection<K>
- Specified by:
iterator
in interfaceObjectIterable<K>
- Specified by:
iterator
in interfaceObjectSet<K>
- Specified by:
iterator
in interfaceObjectSortedSet<K>
- Specified by:
iterator
in interfacejava.util.Set<K>
- Specified by:
iterator
in classAbstractObjectSortedSet<K>
- 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 ObjectLinkedOpenCustomHashSet<K> 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<K>
- Specified by:
hashCode
in interfacejava.util.Set<K>
- Overrides:
hashCode
in classAbstractObjectSet<K>
- Returns:
- a hash code for this set.
-
-