Class CharLinkedOpenHashSet
- All Implemented Interfaces:
it.unimi.dsi.fastutil.chars.CharBidirectionalIterable,it.unimi.dsi.fastutil.chars.CharCollection,it.unimi.dsi.fastutil.chars.CharIterable,CharSet,CharSortedSet,it.unimi.dsi.fastutil.Hash,Serializable,Cloneable,Iterable<Character>,Collection<Character>,SequencedCollection<Character>,SequencedSet<Character>,Set<Character>,SortedSet<Character>
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 the SortedSet
contract because all subset methods throw an exception and comparator() returns always null.
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-specific BidirectionalIterator,
however, all operations will be performed in constant time.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
it.unimi.dsi.fastutil.Hash.Strategy<K> -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanWhether this set contains the null key.protected final floatThe acceptable load factor.protected intThe index of the first entry in iteration order.protected char[]The array of keys.protected intThe index of the last entry in iteration order.protected long[]For each entry, the next and the previous entry in iteration order, stored as((prev & 0xFFFFFFFFL) << 32) | (next & 0xFFFFFFFFL).protected intThe mask for wrapping a position counter.protected intThreshold after which we rehash.protected final intWe never resize below this threshold, which is the construction-time {#n}.protected intThe current table size.protected intNumber of entries in the set (including the null key, if present).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
ConstructorsConstructorDescriptionCreates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.CharLinkedOpenHashSet(char[] a) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying the elements of an array.CharLinkedOpenHashSet(char[] a, float f) Creates a new hash set copying the elements of an array.CharLinkedOpenHashSet(char[] a, int offset, int length) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor and fills it with the elements of a given array.CharLinkedOpenHashSet(char[] a, int offset, int length, float f) Creates a new hash set and fills it with the elements of a given array.CharLinkedOpenHashSet(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.CharLinkedOpenHashSet(int expected, float f) Creates a new hash set.CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharCollection c) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific collection.CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharCollection c, float f) Creates a new hash set copying a given type-specific collection.CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharIterator i) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by a type-specific iterator.CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharIterator i, float f) Creates a new hash set using elements provided by a type-specific iterator.CharLinkedOpenHashSet(Collection<? extends Character> c) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given collection.CharLinkedOpenHashSet(Collection<? extends Character> c, float f) Creates a new hash set copying a given collection.Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by an iterator.CharLinkedOpenHashSet(Iterator<?> i, float f) Creates a new hash set using elements provided by an iterator. -
Method Summary
Modifier and TypeMethodDescriptionbooleanadd(char k) booleanaddAll(it.unimi.dsi.fastutil.chars.CharCollection c) booleanaddAll(Collection<? extends Character> c) booleanaddAndMoveToFirst(char k) Adds a key to the set; if the key is already present, it is moved to the first position of the iteration order.booleanaddAndMoveToLast(char k) Adds a key to the set; if the key is already present, it is moved to the last position of the iteration order.voidclear()Removes all elements from this set.clone()Returns a deep copy of this set.it.unimi.dsi.fastutil.chars.CharComparatorbooleancontains(char k) voidensureCapacity(int capacity) Ensures that this set can hold a certain number of elements without rehashing.charReturns the first element of this set in iteration order.protected voidfixPointers(int i) Modifies thelinkvector so that the given entry is removed.protected voidfixPointers(int s, int d) Modifies thelinkvector for a shift from s to d.voidforEach(it.unimi.dsi.fastutil.chars.CharConsumer action) inthashCode()Returns a hash code for this set.headSet(char to) Returns a view of the portion of this sorted set whose elements are strictly less thantoElement.booleanisEmpty()it.unimi.dsi.fastutil.chars.CharListIteratoriterator()Returns a type-specific list iterator on the elements in this set, starting from the first element.it.unimi.dsi.fastutil.chars.CharListIteratoriterator(char from) Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.charlastChar()Returns the last element of this set in iteration order.static CharLinkedOpenHashSetof()Creates a new empty hash set.static CharLinkedOpenHashSetof(char e) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the given element.static CharLinkedOpenHashSetof(char... a) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using a list of elements.static CharLinkedOpenHashSetof(char e0, char e1) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.static CharLinkedOpenHashSetof(char e0, char e1, char e2) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.protected voidrehash(int newN) Rehashes the set.booleanremove(char k) Removes an element from this set.charRemoves the first key in iteration order.charRemoves the the last key in iteration order.protected final voidshiftKeys(int pos) Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.intsize()it.unimi.dsi.fastutil.chars.CharSpliteratorReturns a type-specific spliterator on the elements of this sorted-set.subSet(char from, char to) Returns a view of the portion of this sorted set whose elements range fromfromElement, inclusive, totoElement, exclusive.tailSet(char from) Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement.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.chars.AbstractCharSet
equals, remMethods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toCharArray, toCharArray, toStringMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toCharArray, toCharArrayMethods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEachMethods inherited from interface it.unimi.dsi.fastutil.chars.CharSortedSet
first, headSet, last, subSet, tailSetMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface java.util.Set
add, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArrayMethods inherited from interface java.util.SortedSet
addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed
-
Field Details
-
key
protected transient char[] keyThe array of keys. -
mask
protected transient int maskThe mask for wrapping a position counter. -
containsNull
protected transient boolean containsNullWhether this set contains the null key. -
first
protected transient int firstThe index of the first entry in iteration order. It is valid iffsizeis nonzero; otherwise, it contains -1. -
last
protected transient int lastThe index of the last entry in iteration order. It is valid iffsizeis nonzero; otherwise, it contains -1. -
link
protected transient long[] linkFor each entry, the next and the previous entry in iteration order, stored as((prev & 0xFFFFFFFFL) << 32) | (next & 0xFFFFFFFFL). The first entry contains predecessor -1, and the last entry contains successor -1. -
n
protected transient int nThe current table size. Note that an additional element is allocated for storing the null key. -
maxFill
protected transient int maxFillThreshold after which we rehash. It must be the table size timesf. -
minN
protected final transient int minNWe never resize below this threshold, which is the construction-time {#n}. -
size
protected int sizeNumber of entries in the set (including the null key, if present). -
f
protected final float fThe acceptable load factor.
-
-
Constructor Details
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(int expected, float f) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(int expected) Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
expected- the expected number of elements in the hash set.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet()Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor. -
CharLinkedOpenHashSet
Creates a new hash set copying a given collection.- Parameters:
c- aCollectionto be copied into the new hash set.f- the load factor.
-
CharLinkedOpenHashSet
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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharCollection c, float f) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharCollection c) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharIterator i, float f) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(it.unimi.dsi.fastutil.chars.CharIterator i) 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.
-
CharLinkedOpenHashSet
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.
-
CharLinkedOpenHashSet
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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(char[] a, int offset, int length, float f) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(char[] a, int offset, int length) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(char[] a, float f) 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.
-
CharLinkedOpenHashSet
public CharLinkedOpenHashSet(char[] a) 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.
-
-
Method Details
-
of
Creates a new empty hash set.- Returns:
- a new empty hash set.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the given element.- Parameters:
e- the element that the returned set will contain.- Returns:
- a new hash set with
Hash.DEFAULT_LOAD_FACTORas load factor containinge.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.- Parameters:
e0- the first element.e1- the second element.- Returns:
- a new hash set with
Hash.DEFAULT_LOAD_FACTORas load factor containinge0ande1. - Throws:
IllegalArgumentException- if there were duplicate entries.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using the elements given.- Parameters:
e0- the first element.e1- the second element.e2- the third element.- Returns:
- a new hash set with
Hash.DEFAULT_LOAD_FACTORas load factor containinge0,e1, ande2. - Throws:
IllegalArgumentException- if there were duplicate entries.
-
of
Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using a list of elements.- Parameters:
a- a list of elements that will be used to initialize the new hash set.- Returns:
- a new hash set with
Hash.DEFAULT_LOAD_FACTORas load factor containing the elements ofa. - Throws:
IllegalArgumentException- if a duplicate entry was encountered.
-
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(it.unimi.dsi.fastutil.chars.CharCollection c) - Specified by:
addAllin interfaceit.unimi.dsi.fastutil.chars.CharCollection- Overrides:
addAllin classit.unimi.dsi.fastutil.chars.AbstractCharCollection
-
addAll
-
add
public boolean add(char k) - Specified by:
addin interfaceit.unimi.dsi.fastutil.chars.CharCollection- Overrides:
addin classit.unimi.dsi.fastutil.chars.AbstractCharCollection
-
shiftKeys
protected final void shiftKeys(int pos) Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.- Parameters:
pos- a starting position.
-
remove
public boolean remove(char k) Description copied from class:AbstractCharSetRemoves an element from this set. Delegates to the type-specificrem()method implemented by type-specific abstractCollectionsuperclass.- Specified by:
removein interfaceCharSet- Overrides:
removein classAbstractCharSet- See Also:
-
contains
public boolean contains(char k) - Specified by:
containsin interfaceit.unimi.dsi.fastutil.chars.CharCollection- Overrides:
containsin classit.unimi.dsi.fastutil.chars.AbstractCharCollection
-
removeFirstChar
public char removeFirstChar()Removes the first key in iteration order.- Returns:
- the first key.
- Throws:
NoSuchElementException- is this set is empty.
-
removeLastChar
public char removeLastChar()Removes the the last key in iteration order.- Returns:
- the last key.
- Throws:
NoSuchElementException- is this set is empty.
-
addAndMoveToFirst
public boolean addAndMoveToFirst(char 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(char 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()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<Character>- Specified by:
clearin interfaceSet<Character>- Overrides:
clearin classAbstractCollection<Character>
-
size
public int size()- Specified by:
sizein interfaceCollection<Character>- Specified by:
sizein interfaceSet<Character>- Specified by:
sizein classAbstractCollection<Character>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmptyin interfaceCollection<Character>- Specified by:
isEmptyin interfaceSet<Character>- Overrides:
isEmptyin classAbstractCollection<Character>
-
fixPointers
protected void fixPointers(int i) Modifies thelinkvector so that the given entry is removed. This method will complete in constant time.- Parameters:
i- the index of an entry.
-
fixPointers
protected void fixPointers(int s, int d) Modifies thelinkvector for a shift from s to d. This method will complete in constant time.- Parameters:
s- the source position.d- the destination position.
-
firstChar
public char firstChar()Returns the first element of this set in iteration order.- Specified by:
firstCharin interfaceCharSortedSet- Returns:
- the first element in iteration order.
- See Also:
-
lastChar
public char lastChar()Returns the last element of this set in iteration order.- Specified by:
lastCharin interfaceCharSortedSet- Returns:
- the last element in iteration order.
- See Also:
-
tailSet
Returns a view of the portion of this sorted set whose elements are greater than or equal tofromElement.- Specified by:
tailSetin interfaceCharSortedSet- See Also:
-
headSet
Returns a view of the portion of this sorted set whose elements are strictly less thantoElement.- Specified by:
headSetin interfaceCharSortedSet- See Also:
-
subSet
Returns a view of the portion of this sorted set whose elements range fromfromElement, inclusive, totoElement, exclusive.- Specified by:
subSetin interfaceCharSortedSet- See Also:
-
comparator
public it.unimi.dsi.fastutil.chars.CharComparator comparator()- Specified by:
comparatorin interfaceCharSortedSet- Specified by:
comparatorin interfaceSortedSet<Character>
-
iterator
public it.unimi.dsi.fastutil.chars.CharListIterator iterator(char 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:
iteratorin interfaceCharSortedSet- Parameters:
from- an element to start from.- Returns:
- a type-specific list iterator starting at the given element.
- Throws:
IllegalArgumentException- iffromdoes not belong to the set.
-
iterator
public it.unimi.dsi.fastutil.chars.CharListIterator 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:
iteratorin interfaceit.unimi.dsi.fastutil.chars.CharBidirectionalIterable- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.chars.CharCollection- Specified by:
iteratorin interfaceit.unimi.dsi.fastutil.chars.CharIterable- Specified by:
iteratorin interfaceCharSet- Specified by:
iteratorin interfaceCharSortedSet- Specified by:
iteratorin interfaceCollection<Character>- Specified by:
iteratorin interfaceIterable<Character>- Specified by:
iteratorin interfaceSet<Character>- Specified by:
iteratorin classAbstractCharSortedSet- Returns:
- a type-specific list iterator starting at the first element.
-
spliterator
public it.unimi.dsi.fastutil.chars.CharSpliterator 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'sCharSortedSet.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:
spliteratorin interfaceit.unimi.dsi.fastutil.chars.CharCollection- Specified by:
spliteratorin interfaceit.unimi.dsi.fastutil.chars.CharIterable- Specified by:
spliteratorin interfaceCharSet- Specified by:
spliteratorin interfaceCharSortedSet- Specified by:
spliteratorin interfaceCollection<Character>- Specified by:
spliteratorin interfaceIterable<Character>- Specified by:
spliteratorin interfaceSet<Character>- Specified by:
spliteratorin interfaceSortedSet<Character>- Returns:
-
forEach
public void forEach(it.unimi.dsi.fastutil.chars.CharConsumer action) - Specified by:
forEachin interfaceit.unimi.dsi.fastutil.chars.CharIterable
-
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:
-
rehash
protected void rehash(int newN) Rehashes the set.This method implements the basic rehashing strategy, and may be overriden by subclasses implementing different rehashing strategies (e.g., disk-based rehashing). However, you should not override this method unless you understand the internal workings of this class.
- Parameters:
newN- the new size
-
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.
-
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<Character>- Specified by:
hashCodein interfaceSet<Character>- Overrides:
hashCodein classAbstractCharSet- Returns:
- a hash code for this set.
-