public class ByteLinkedOpenHashSet extends AbstractByteSortedSet implements Serializable, Cloneable, Hash
Instances of this class use a hash table to represent a set. The table is
enlarged as needed by doubling its size when new entries are created, but it is never made
smaller (even on a clear()). 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 AbstractByteSortedSet.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.
Hash,
HashCommon,
Serialized FormHash.Strategy<K>| Modifier and Type | Field and Description |
|---|---|
protected float |
f
The acceptable load factor.
|
protected int |
first
The index of the first entry in iteration order.
|
protected byte[] |
key
The array of keys.
|
protected int |
last
The index of the last entry in iteration order.
|
protected long[] |
link
For each entry, the next and the previous entry in iteration order,
stored as
((prev & 0xFFFFFFFFL) << 32) | (next & 0xFFFFFFFFL). |
protected int |
mask
The mask for wrapping a position counter.
|
protected int |
maxFill
Threshold after which we rehash.
|
protected int |
n
The current table size.
|
static long |
serialVersionUID |
protected int |
size
Number of entries in the set.
|
protected boolean[] |
used
The array telling whether a position is used.
|
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
ByteLinkedOpenHashSet()
Creates a new hash set with initial expected
Hash.DEFAULT_INITIAL_SIZE elements
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
ByteLinkedOpenHashSet(byte[] a)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying the elements of an array. |
ByteLinkedOpenHashSet(byte[] a,
float f)
Creates a new hash set copying the elements of an array.
|
ByteLinkedOpenHashSet(byte[] a,
int offset,
int length)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array. |
ByteLinkedOpenHashSet(byte[] a,
int offset,
int length,
float f)
Creates a new hash set and fills it with the elements of a given array.
|
ByteLinkedOpenHashSet(ByteCollection c)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given type-specific collection. |
ByteLinkedOpenHashSet(ByteCollection c,
float f)
Creates a new hash set copying a given type-specific collection.
|
ByteLinkedOpenHashSet(ByteIterator i)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator. |
ByteLinkedOpenHashSet(ByteIterator i,
float f)
Creates a new hash set using elements provided by a type-specific iterator.
|
ByteLinkedOpenHashSet(Collection<? extends Byte> c)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given collection. |
ByteLinkedOpenHashSet(Collection<? extends Byte> c,
float f)
Creates a new hash set copying a given collection.
|
ByteLinkedOpenHashSet(int expected)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
ByteLinkedOpenHashSet(int expected,
float f)
Creates a new hash set.
|
ByteLinkedOpenHashSet(Iterator<?> i)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator. |
ByteLinkedOpenHashSet(Iterator<?> i,
float f)
Creates a new hash set using elements provided by an iterator.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(byte k) |
boolean |
addAndMoveToFirst(byte 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(byte 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() |
ByteLinkedOpenHashSet |
clone()
Returns a deep copy of this set.
|
ByteComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
|
boolean |
contains(byte k) |
byte |
firstByte()
Returns the first element of this set in iteration order.
|
protected void |
fixPointers(int i)
Modifies the
link vector so that the given entry is removed. |
protected void |
fixPointers(int s,
int d)
Modifies the
link vector for a shift from s to d. |
int |
growthFactor()
Deprecated.
Since
fastutil 6.1.0, hash tables are doubled when they are too full. |
void |
growthFactor(int growthFactor)
Deprecated.
Since
fastutil 6.1.0, hash tables are doubled when they are too full. |
int |
hashCode()
Returns a hash code for this set.
|
ByteSortedSet |
headSet(byte to) |
boolean |
isEmpty() |
ByteListIterator |
iterator()
Returns a type-specific iterator on the elements of this collection.
|
ByteListIterator |
iterator(byte from)
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.
|
byte |
lastByte()
Returns the last element of this set in iteration order.
|
boolean |
rehash()
Deprecated.
A no-op.
|
protected void |
rehash(int newN)
Resizes the set.
|
boolean |
remove(byte k)
Removes an element from this set.
|
byte |
removeFirstByte()
Removes the first key in iteration order.
|
byte |
removeLastByte()
Removes the the last key in iteration order.
|
protected int |
shiftKeys(int pos)
Shifts left entries with the specified hash code, starting at the specified position,
and empties the resulting free entry.
|
int |
size() |
ByteSortedSet |
subSet(byte from,
byte to) |
ByteSortedSet |
tailSet(byte from) |
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.
|
byteIterator, first, headSet, last, subSet, tailSetequals, rem, removeadd, addAll, addAll, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toByteArray, toByteArray, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitaddAll, containsAll, rem, removeAll, retainAll, toArray, toArray, toByteArray, toByteArraypublic static final long serialVersionUID
protected transient byte[] key
protected transient boolean[] used
protected final float f
protected transient int n
protected transient int maxFill
f.protected transient int mask
protected int size
protected transient int first
size is nonzero; otherwise, it contains -1.protected transient int last
size is nonzero; otherwise, it contains -1.protected transient long[] link
((prev & 0xFFFFFFFFL) << 32) | (next & 0xFFFFFFFFL).
The first entry contains predecessor -1, and the last entry
contains successor -1.public ByteLinkedOpenHashSet(int expected,
float f)
The actual table size will be the least power of two greater than expected/f.
expected - the expected number of elements in the hash set.f - the load factor.public ByteLinkedOpenHashSet(int expected)
Hash.DEFAULT_LOAD_FACTOR as load factor.expected - the expected number of elements in the hash set.public ByteLinkedOpenHashSet()
Hash.DEFAULT_INITIAL_SIZE elements
and Hash.DEFAULT_LOAD_FACTOR as load factor.public ByteLinkedOpenHashSet(Collection<? extends Byte> c, float f)
c - a Collection to be copied into the new hash set.f - the load factor.public ByteLinkedOpenHashSet(Collection<? extends Byte> c)
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given collection.c - a Collection to be copied into the new hash set.public ByteLinkedOpenHashSet(ByteCollection c, float f)
c - a type-specific collection to be copied into the new hash set.f - the load factor.public ByteLinkedOpenHashSet(ByteCollection c)
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given type-specific collection.c - a type-specific collection to be copied into the new hash set.public ByteLinkedOpenHashSet(ByteIterator i, float f)
i - a type-specific iterator whose elements will fill the set.f - the load factor.public ByteLinkedOpenHashSet(ByteIterator i)
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.i - a type-specific iterator whose elements will fill the set.public ByteLinkedOpenHashSet(Iterator<?> i, float f)
i - an iterator whose elements will fill the set.f - the load factor.public ByteLinkedOpenHashSet(Iterator<?> i)
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator.i - an iterator whose elements will fill the set.public ByteLinkedOpenHashSet(byte[] a,
int offset,
int length,
float f)
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.public ByteLinkedOpenHashSet(byte[] a,
int offset,
int length)
Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.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.public ByteLinkedOpenHashSet(byte[] a,
float f)
a - an array to be copied into the new hash set.f - the load factor.public ByteLinkedOpenHashSet(byte[] a)
Hash.DEFAULT_LOAD_FACTOR as load factor
copying the elements of an array.a - an array to be copied into the new hash set.public boolean add(byte k)
add in interface ByteCollectionadd in class AbstractByteCollectionCollection.add(Object)protected final int shiftKeys(int pos)
pos - a starting position.public boolean remove(byte k)
ByteSetNote that the corresponding method of the type-specific collection is rem().
This unfortunate situation is caused by the clash
with the similarly named index-based method in the List interface.
remove in interface ByteSetremove in class AbstractByteSetCollection.remove(Object)public boolean contains(byte k)
contains in interface ByteCollectioncontains in class AbstractByteCollectionCollection.contains(Object)public byte removeFirstByte()
NoSuchElementException - is this set is empty.public byte removeLastByte()
NoSuchElementException - is this set is empty.public boolean addAndMoveToFirst(byte k)
k - the key.public boolean addAndMoveToLast(byte k)
k - the key.public void clear()
clear in interface Collection<Byte>clear in interface Set<Byte>clear in class AbstractCollection<Byte>public int size()
size in interface Collection<Byte>size in interface Set<Byte>size in class AbstractCollection<Byte>public boolean isEmpty()
isEmpty in interface Collection<Byte>isEmpty in interface Set<Byte>isEmpty in class AbstractByteCollection@Deprecated public void growthFactor(int growthFactor)
fastutil 6.1.0, hash tables are doubled when they are too full.growthFactor - unused.@Deprecated public int growthFactor()
fastutil 6.1.0, hash tables are doubled when they are too full.growthFactor(int)protected void fixPointers(int i)
link vector so that the given entry is removed.
If the given entry is the first or the last one, this method will complete in constant time; otherwise, it will have to search for the given entry.
i - the index of an entry.protected void fixPointers(int s,
int d)
link vector for a shift from s to d.
If the given entry is the first or the last one, this method will complete in constant time; otherwise, it will have to search for the given entry.
s - the source position.d - the destination position.public byte firstByte()
firstByte in interface ByteSortedSetSortedSet.first()public byte lastByte()
lastByte in interface ByteSortedSetSortedSet.last()public ByteSortedSet tailSet(byte from)
tailSet in interface ByteSortedSetSortedSet.tailSet(Object)public ByteSortedSet headSet(byte to)
headSet in interface ByteSortedSetSortedSet.headSet(Object)public ByteSortedSet subSet(byte from, byte to)
subSet in interface ByteSortedSetSortedSet.subSet(Object,Object)public ByteComparator comparator()
ByteSortedSetNote that this specification strengthens the one given in SortedSet.comparator().
comparator in interface ByteSortedSetcomparator in interface SortedSet<Byte>SortedSet.comparator()public ByteListIterator iterator(byte from)
iterator in interface ByteSortedSetfrom - an element to start from.IllegalArgumentException - if from does not belong to the set.public ByteListIterator iterator()
ByteCollectionNote that this specification strengthens the one given in
Iterable.iterator(), which was already
strengthened in the corresponding type-specific class,
but was weakened by the fact that this interface extends Collection.
iterator in interface ByteCollectioniterator in interface ByteIterableiterator in interface ByteSetiterator in interface ByteSortedSetiterator in interface Iterable<Byte>iterator in interface Collection<Byte>iterator in interface Set<Byte>iterator in class AbstractByteSortedSet@Deprecated public boolean rehash()
If you need to reduce the table size to fit exactly
this set, use trim().
trim()public boolean trim()
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.
trim(int)public boolean trim(int n)
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.
n - the threshold for the trimming.trim()protected void rehash(int newN)
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.
newN - the new sizepublic ByteLinkedOpenHashSet clone()
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.
public int hashCode()
equals() 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.hashCode in interface Collection<Byte>hashCode in interface Set<Byte>hashCode in class AbstractByteSetCopyright © 2013. All Rights Reserved.