Class CharLinkedOpenCustomHashSet
- java.lang.Object
-
- java.util.AbstractCollection<Character>
-
- it.unimi.dsi.fastutil.chars.AbstractCharCollection
-
- it.unimi.dsi.fastutil.chars.AbstractCharSet
-
- it.unimi.dsi.fastutil.chars.AbstractCharSortedSet
-
- it.unimi.dsi.fastutil.chars.CharLinkedOpenCustomHashSet
-
- All Implemented Interfaces:
CharBidirectionalIterable,CharCollection,CharIterable,CharSet,CharSortedSet,Hash,Serializable,Cloneable,Iterable<Character>,Collection<Character>,Set<Character>,SortedSet<Character>
public class CharLinkedOpenCustomHashSet extends AbstractCharSortedSet 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 theSortedSetcontract 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
NoSuchElementExceptionexception 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 CharLinkedOpenCustomHashSet(char[] a, float f, CharHash.Strategy strategy)Creates a new hash set copying the elements of an array.CharLinkedOpenCustomHashSet(char[] a, int offset, int length, float f, CharHash.Strategy strategy)Creates a new hash set and fills it with the elements of a given array.CharLinkedOpenCustomHashSet(char[] a, int offset, int length, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor and fills it with the elements of a given array.CharLinkedOpenCustomHashSet(char[] a, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying the elements of an array.CharLinkedOpenCustomHashSet(int expected, float f, CharHash.Strategy strategy)Creates a new hash set.CharLinkedOpenCustomHashSet(int expected, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor.CharLinkedOpenCustomHashSet(CharCollection c, float f, CharHash.Strategy strategy)Creates a new hash set copying a given type-specific collection.CharLinkedOpenCustomHashSet(CharCollection c, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific collection.CharLinkedOpenCustomHashSet(CharHash.Strategy strategy)Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.CharLinkedOpenCustomHashSet(CharIterator i, float f, CharHash.Strategy strategy)Creates a new hash set using elements provided by a type-specific iterator.CharLinkedOpenCustomHashSet(CharIterator i, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by a type-specific iterator.CharLinkedOpenCustomHashSet(Collection<? extends Character> c, float f, CharHash.Strategy strategy)Creates a new hash set copying a given collection.CharLinkedOpenCustomHashSet(Collection<? extends Character> c, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor copying a given collection.CharLinkedOpenCustomHashSet(Iterator<?> i, float f, CharHash.Strategy strategy)Creates a new hash set using elements provided by an iterator.CharLinkedOpenCustomHashSet(Iterator<?> i, CharHash.Strategy strategy)Creates a new hash set withHash.DEFAULT_LOAD_FACTORas load factor using elements provided by an iterator.
-
Method Summary
Modifier and Type Method Description booleanadd(char k)Ensures that this collection contains the specified element (optional operation).booleanaddAll(CharCollection c)Adds all elements of the given type-specific collection to this collection.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()CharLinkedOpenCustomHashSetclone()Returns a deep copy of this set.CharComparatorcomparator()booleancontains(char k)Returnstrueif this collection contains the specified element.charfirstChar()Returns the first element of this set in iteration order.inthashCode()Returns a hash code for this set.CharSortedSetheadSet(char to)Returns a view of the portion of this sorted set whose elements are strictly less thantoElement.booleanisEmpty()CharListIteratoriterator()Returns a type-specific list iterator on the elements in this set, starting from the first element.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.booleanremove(char k)Removes an element from this set.charremoveFirstChar()Removes the first key in iteration order.charremoveLastChar()Removes the the last key in iteration order.intsize()CharHash.Strategystrategy()Returns the hashing strategy.CharSortedSetsubSet(char from, char to)Returns a view of the portion of this sorted set whose elements range fromfromElement, inclusive, totoElement, exclusive.CharSortedSettailSet(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, rem
-
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, contains, containsAll, remove, removeAll, retainAll, toArray, toCharArray, toCharArray, toString
-
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toArray, toArray
-
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toCharArray, toCharArray
-
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable
forEach, forEach
-
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSortedSet
first, headSet, last, subSet, tailSet
-
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 java.util.SortedSet
spliterator
-
-
-
-
Constructor Detail
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(int expected, float f, CharHash.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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(int expected, CharHash.Strategy strategy)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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(CharHash.Strategy strategy)
Creates a new hash set with initial expectedHash.DEFAULT_INITIAL_SIZEelements andHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
strategy- the strategy.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(Collection<? extends Character> c, float f, CharHash.Strategy strategy)
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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(Collection<? extends Character> c, CharHash.Strategy strategy)
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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(CharCollection c, float f, CharHash.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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(CharCollection c, CharHash.Strategy strategy)
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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(CharIterator i, float f, CharHash.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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(CharIterator i, CharHash.Strategy strategy)
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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(Iterator<?> i, float f, CharHash.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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(Iterator<?> i, CharHash.Strategy strategy)
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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(char[] a, int offset, int length, float f, CharHash.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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(char[] a, int offset, int length, CharHash.Strategy strategy)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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(char[] a, float f, CharHash.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.
-
CharLinkedOpenCustomHashSet
public CharLinkedOpenCustomHashSet(char[] a, CharHash.Strategy strategy)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 Detail
-
strategy
public CharHash.Strategy strategy()
Returns the hashing strategy.- Returns:
- the hashing strategy of this custom hash set.
-
addAll
public boolean addAll(CharCollection c)
Description copied from interface:CharCollectionAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceCharCollection- Overrides:
addAllin classAbstractCharCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
Collection.addAll(Collection)
-
addAll
public boolean addAll(Collection<? extends Character> c)
- Specified by:
addAllin interfaceCollection<Character>- Specified by:
addAllin interfaceSet<Character>- Overrides:
addAllin classAbstractCollection<Character>
-
add
public boolean add(char k)
Description copied from class:AbstractCharCollectionEnsures that this collection contains the specified element (optional operation).This implementation always throws an
UnsupportedOperationException.- Specified by:
addin interfaceCharCollection- Overrides:
addin classAbstractCharCollection- See Also:
Collection.add(Object)
-
remove
public boolean remove(char k)
Description copied from class:AbstractCharSetRemoves 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 theListinterface. Delegates to the type-specificrem()method implemented by type-specific abstractCollectionsuperclass.- Specified by:
removein interfaceCharSet- Overrides:
removein classAbstractCharSet- See Also:
Collection.remove(Object)
-
contains
public boolean contains(char k)
Description copied from class:AbstractCharCollectionReturnstrueif this collection contains the specified element.This implementation iterates over the elements in the collection, looking for the specified element.
- Specified by:
containsin interfaceCharCollection- Overrides:
containsin classAbstractCharCollection- See Also:
Collection.contains(Object)
-
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()
- 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>
-
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:
SortedSet.first()
-
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:
SortedSet.last()
-
tailSet
public CharSortedSet tailSet(char 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:
tailSetin interfaceCharSortedSet- See Also:
SortedSet.tailSet(Object)
-
headSet
public CharSortedSet headSet(char 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:
headSetin interfaceCharSortedSet- See Also:
SortedSet.headSet(Object)
-
subSet
public CharSortedSet subSet(char from, char 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:
subSetin interfaceCharSortedSet- See Also:
SortedSet.subSet(Object,Object)
-
comparator
public CharComparator comparator()
Note that this specification strengthens the one given in
SortedSet.comparator().This implementation just returns
null.- Specified by:
comparatorin interfaceCharSortedSet- Specified by:
comparatorin interfaceSortedSet<Character>
-
iterator
public 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 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 interfaceCharBidirectionalIterable- Specified by:
iteratorin interfaceCharCollection- Specified by:
iteratorin interfaceCharIterable- 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.
- 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 CharLinkedOpenCustomHashSet 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<Character>- Specified by:
hashCodein interfaceSet<Character>- Overrides:
hashCodein classAbstractCharSet- Returns:
- a hash code for this set.
-
-