public class FloatLinkedOpenCustomHashSet extends AbstractFloatSortedSet implements Serializable, Cloneable, Hash
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, 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 AbstractFloatSortedSet.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>
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
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 with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection. |
FloatLinkedOpenCustomHashSet(float[] a,
float f,
FloatHash.Strategy strategy)
Creates a new hash set copying the elements of an array.
|
FloatLinkedOpenCustomHashSet(float[] a,
FloatHash.Strategy strategy)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor 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 with
Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array. |
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 with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection. |
FloatLinkedOpenCustomHashSet(FloatHash.Strategy strategy)
Creates a new hash set with initial expected
Hash.DEFAULT_INITIAL_SIZE elements and Hash.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 with
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator. |
FloatLinkedOpenCustomHashSet(int expected,
float f,
FloatHash.Strategy strategy)
Creates a new hash set.
|
FloatLinkedOpenCustomHashSet(int expected,
FloatHash.Strategy strategy)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
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 with
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator. |
Modifier and Type | Method and Description |
---|---|
boolean |
add(float k) |
boolean |
addAll(Collection<? extends Float> c)
Adds all elements of the given collection to this collection.
|
boolean |
addAll(FloatCollection c)
Adds all elements of the given type-specific collection to this collection.
|
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()
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
|
boolean |
contains(float k) |
float |
firstFloat()
Returns the first element of this set in iteration order.
|
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.
|
FloatSortedSet |
headSet(float to) |
boolean |
isEmpty() |
FloatListIterator |
iterator()
Returns a type-specific iterator on the elements of this collection.
|
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 |
rehash()
Deprecated.
A no-op.
|
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) |
FloatSortedSet |
tailSet(float 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.
|
first, floatIterator, headSet, last, subSet, tailSet
equals, rem, remove
add, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toFloatArray, toFloatArray, toString
containsAll, rem, removeAll, retainAll, toArray, toArray, toFloatArray, toFloatArray
spliterator
add, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArray
parallelStream, removeIf, stream
public FloatLinkedOpenCustomHashSet(int expected, float f, FloatHash.Strategy strategy)
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.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(int expected, FloatHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash set.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(FloatHash.Strategy strategy)
Hash.DEFAULT_INITIAL_SIZE
elements and Hash.DEFAULT_LOAD_FACTOR
as load factor.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(Collection<? extends Float> c, float f, FloatHash.Strategy strategy)
c
- a Collection
to be copied into the new hash set.f
- the load factor.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(Collection<? extends Float> c, FloatHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given collection.c
- a Collection
to be copied into the new hash set.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(FloatCollection c, float f, FloatHash.Strategy strategy)
c
- a type-specific collection to be copied into the new hash set.f
- the load factor.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(FloatCollection c, FloatHash.Strategy strategy)
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.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(FloatIterator i, float f, FloatHash.Strategy strategy)
i
- a type-specific iterator whose elements will fill the set.f
- the load factor.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(FloatIterator i, FloatHash.Strategy strategy)
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.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(Iterator<?> i, float f, FloatHash.Strategy strategy)
i
- an iterator whose elements will fill the set.f
- the load factor.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(Iterator<?> i, FloatHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor using elements provided by an iterator.i
- an iterator whose elements will fill the set.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(float[] a, int offset, int length, float f, FloatHash.Strategy strategy)
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.public FloatLinkedOpenCustomHashSet(float[] a, int offset, int length, FloatHash.Strategy strategy)
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.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(float[] a, float f, FloatHash.Strategy strategy)
a
- an array to be copied into the new hash set.f
- the load factor.strategy
- the strategy.public FloatLinkedOpenCustomHashSet(float[] a, FloatHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying the elements of an array.a
- an array to be copied into the new hash set.strategy
- the strategy.public FloatHash.Strategy strategy()
public boolean addAll(FloatCollection c)
addAll
in interface FloatCollection
addAll
in class AbstractFloatCollection
c
- a type-specific collection.true
if this collection changed as a result of the call.Collection.addAll(Collection)
public boolean addAll(Collection<? extends Float> c)
addAll
in interface Collection<Float>
addAll
in interface Set<Float>
addAll
in class AbstractFloatCollection
c
- a collection.true
if this collection changed as a result of the call.public boolean add(float k)
add
in interface FloatCollection
add
in class AbstractFloatCollection
Collection.add(Object)
public boolean remove(float k)
FloatSet
Note 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 FloatSet
remove
in class AbstractFloatSet
Collection.remove(Object)
public boolean contains(float k)
contains
in interface FloatCollection
contains
in class AbstractFloatCollection
Collection.contains(Object)
public float removeFirstFloat()
NoSuchElementException
- is this set is empty.public float removeLastFloat()
NoSuchElementException
- is this set is empty.public boolean addAndMoveToFirst(float k)
k
- the key.public boolean addAndMoveToLast(float k)
k
- the key.public void clear()
clear
in interface Collection<Float>
clear
in interface Set<Float>
clear
in class AbstractCollection<Float>
public int size()
size
in interface Collection<Float>
size
in interface Set<Float>
size
in class AbstractCollection<Float>
public boolean isEmpty()
isEmpty
in interface Collection<Float>
isEmpty
in interface Set<Float>
isEmpty
in class AbstractFloatCollection
@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)
public float firstFloat()
firstFloat
in interface FloatSortedSet
SortedSet.first()
public float lastFloat()
lastFloat
in interface FloatSortedSet
SortedSet.last()
public FloatSortedSet tailSet(float from)
tailSet
in interface FloatSortedSet
SortedSet.tailSet(Object)
public FloatSortedSet headSet(float to)
headSet
in interface FloatSortedSet
SortedSet.headSet(Object)
public FloatSortedSet subSet(float from, float to)
subSet
in interface FloatSortedSet
SortedSet.subSet(Object,Object)
public FloatComparator comparator()
FloatSortedSet
Note that this specification strengthens the one given in SortedSet.comparator()
.
comparator
in interface FloatSortedSet
comparator
in interface SortedSet<Float>
SortedSet.comparator()
public FloatListIterator iterator(float from)
iterator
in interface FloatSortedSet
from
- an element to start from.IllegalArgumentException
- if from
does not belong to the set.public FloatListIterator iterator()
FloatCollection
Note 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 FloatCollection
iterator
in interface FloatIterable
iterator
in interface FloatSet
iterator
in interface FloatSortedSet
iterator
in interface Iterable<Float>
iterator
in interface Collection<Float>
iterator
in interface Set<Float>
iterator
in class AbstractFloatSortedSet
@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()
public FloatLinkedOpenCustomHashSet 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<Float>
hashCode
in interface Set<Float>
hashCode
in class AbstractFloatSet