public class ReferenceOpenHashSet<K> extends AbstractReferenceSet<K> implements java.io.Serializable, java.lang.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.
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 |
---|
ReferenceOpenHashSet()
Creates a new hash set with initial expected
Hash.DEFAULT_INITIAL_SIZE elements
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
ReferenceOpenHashSet(java.util.Collection<? extends K> c)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given collection. |
ReferenceOpenHashSet(java.util.Collection<? extends K> c,
float f)
Creates a new hash set copying a given collection.
|
ReferenceOpenHashSet(int expected)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
ReferenceOpenHashSet(int expected,
float f)
Creates a new hash set.
|
ReferenceOpenHashSet(java.util.Iterator<? extends K> i)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator. |
ReferenceOpenHashSet(java.util.Iterator<? extends K> i,
float f)
Creates a new hash set using elements provided by a type-specific iterator.
|
ReferenceOpenHashSet(K[] a)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying the elements of an array. |
ReferenceOpenHashSet(K[] a,
float f)
Creates a new hash set copying the elements of an array.
|
ReferenceOpenHashSet(K[] 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. |
ReferenceOpenHashSet(K[] a,
int offset,
int length,
float f)
Creates a new hash set and fills it with the elements of a given array.
|
ReferenceOpenHashSet(ReferenceCollection<? extends K> c)
Creates a new hash set with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given type-specific collection. |
ReferenceOpenHashSet(ReferenceCollection<? extends K> c,
float f)
Creates a new hash set copying a given type-specific collection.
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(K k) |
boolean |
addAll(java.util.Collection<? extends K> c)
Adds all elements of the given collection to this collection.
|
void |
clear() |
ReferenceOpenHashSet<K> |
clone()
Returns a deep copy of this set.
|
boolean |
contains(java.lang.Object k) |
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.
|
boolean |
isEmpty() |
ObjectIterator<K> |
iterator()
Returns a type-specific iterator on the elements of this collection.
|
boolean |
rehash()
Deprecated.
A no-op.
|
boolean |
remove(java.lang.Object k)
Removes an element from this set.
|
int |
size() |
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.
|
equals
containsAll, objectIterator, removeAll, retainAll, toArray, toArray, toString
objectIterator, toArray
public ReferenceOpenHashSet(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 ReferenceOpenHashSet(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash set.public ReferenceOpenHashSet()
Hash.DEFAULT_INITIAL_SIZE
elements
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public ReferenceOpenHashSet(java.util.Collection<? extends K> c, float f)
c
- a Collection
to be copied into the new hash set.f
- the load factor.public ReferenceOpenHashSet(java.util.Collection<? extends K> c)
Hash.DEFAULT_LOAD_FACTOR
as load factor
copying a given collection.c
- a Collection
to be copied into the new hash set.public ReferenceOpenHashSet(ReferenceCollection<? extends K> c, float f)
c
- a type-specific collection to be copied into the new hash set.f
- the load factor.public ReferenceOpenHashSet(ReferenceCollection<? extends K> 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 ReferenceOpenHashSet(java.util.Iterator<? extends K> i, float f)
i
- a type-specific iterator whose elements will fill the set.f
- the load factor.public ReferenceOpenHashSet(java.util.Iterator<? extends K> 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 ReferenceOpenHashSet(K[] 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 ReferenceOpenHashSet(K[] 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 ReferenceOpenHashSet(K[] a, float f)
a
- an array to be copied into the new hash set.f
- the load factor.public ReferenceOpenHashSet(K[] 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 addAll(java.util.Collection<? extends K> c)
addAll
in interface java.util.Collection<K>
addAll
in interface java.util.Set<K>
addAll
in class AbstractReferenceCollection<K>
c
- a collection.true
if this collection changed as a result of the call.public boolean add(K k)
add
in interface java.util.Collection<K>
add
in interface java.util.Set<K>
add
in class AbstractReferenceCollection<K>
public boolean remove(java.lang.Object k)
ReferenceSet
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 ReferenceSet<K>
remove
in interface java.util.Collection<K>
remove
in interface java.util.Set<K>
remove
in class AbstractReferenceSet<K>
Collection.remove(Object)
public boolean contains(java.lang.Object k)
public void clear()
public int size()
public boolean isEmpty()
isEmpty
in interface java.util.Collection<K>
isEmpty
in interface java.util.Set<K>
isEmpty
in class AbstractReferenceCollection<K>
@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 ObjectIterator<K> iterator()
ReferenceCollection
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 ObjectIterable<K>
iterator
in interface ReferenceCollection<K>
iterator
in interface ReferenceSet<K>
iterator
in interface java.lang.Iterable<K>
iterator
in interface java.util.Collection<K>
iterator
in interface java.util.Set<K>
iterator
in class AbstractReferenceSet<K>
@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 ReferenceOpenHashSet<K> 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.
clone
in class java.lang.Object
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 java.util.Collection<K>
hashCode
in interface java.util.Set<K>
hashCode
in class AbstractReferenceSet<K>