org.agrona.collections

Class ObjectHashSet<T>

java.lang.Object

org.agrona.collections.ObjectHashSet<T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

public final class ObjectHashSet<T>
extends java.lang.Object
implements java.util.Set<T>

Open-addressing with linear-probing expandable hash set. Allocation free in steady state use when expanded. Ability to be notified when resizing occurs so that appropriate sizing can be implemented. Not Threadsafe. This HashSet caches its iterator object, so nested iteration is not supported.

See Also:

ObjectIterator, Set

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INITIAL_CAPACITY The initial capacity used when none is specified in the constructor.
static float	DEFAULT_LOAD_FACTOR The load factor used when none is specified in the constructor.

Constructor Summary

Constructors

Constructor and Description
ObjectHashSet()
ObjectHashSet(int proposedCapacity)
ObjectHashSet(int initialCapacity, float loadFactor)

Method Summary

Modifier and Type	Method and Description
boolean	add(T value)
boolean	addAll(java.util.Collection<? extends T> coll)
int	capacity() Get the total capacity for the set to which the load factor with be a fraction of.
void	clear()
void	compact() Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
boolean	contains(java.lang.Object value)
boolean	containsAll(java.util.Collection<?> coll)
void	copy(ObjectHashSet<T> that)
ObjectHashSet<T>	difference(ObjectHashSet<T> other) Fast Path set difference for comparison with another ObjectHashSet.
boolean	equals(java.lang.Object other)
int	hashCode()
boolean	isEmpty()
ObjectIterator<T>	iterator()
float	loadFactor() Get the load factor beyond which the set will increase size.
boolean	remove(java.lang.Object value)
boolean	removeAll(java.util.Collection<?> coll)
void	resizeNotifier(java.util.function.IntConsumer resizeNotifier) Add a Consumer that will be called when the collection is resized.
boolean	retainAll(java.util.Collection<?> coll)
int	size()
java.lang.Object[]	toArray()
<T1> T1[]	toArray(T1[] into)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT_LOAD_FACTOR

public static final float DEFAULT_LOAD_FACTOR

The load factor used when none is specified in the constructor.

See Also:

Constant Field Values

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial capacity used when none is specified in the constructor.

See Also:

Constant Field Values

Constructor Detail

ObjectHashSet

public ObjectHashSet()

ObjectHashSet

public ObjectHashSet(int proposedCapacity)

ObjectHashSet

public ObjectHashSet(int initialCapacity,
                     float loadFactor)

Method Detail

resizeNotifier

public void resizeNotifier(java.util.function.IntConsumer resizeNotifier)

Add a Consumer that will be called when the collection is resized.

Parameters:

resizeNotifier - IntConsumer containing the new resizeThreshold

add

public boolean add(T value)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

Parameters:

value - the value to add

Returns:

true if the collection has changed, false otherwise

Throws:

java.lang.NullPointerException - if the value is null

remove

public boolean remove(java.lang.Object value)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Set<T>

Parameters:

value - the value to remove

Returns:

true if the value was present, false otherwise

compact

public void compact()

Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.

contains

public boolean contains(java.lang.Object value)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Set<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.Set<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.Set<T>

loadFactor

public float loadFactor()

Get the load factor beyond which the set will increase size.

Returns:

load factor for when the set should increase size.

capacity

public int capacity()

Get the total capacity for the set to which the load factor with be a fraction of.

Returns:

the total capacity for the set.

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

containsAll

public boolean containsAll(java.util.Collection<?> coll)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.Set<T>

addAll

public boolean addAll(java.util.Collection<? extends T> coll)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.Set<T>

difference

public ObjectHashSet<T> difference(ObjectHashSet<T> other)

Fast Path set difference for comparison with another ObjectHashSet.

NB: garbage free in the identical case, allocates otherwise.

Parameters:

other - the other set to subtract

Returns:

null if identical, otherwise the set of differences

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.Set<T>

iterator

public ObjectIterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Set<T>

copy

public void copy(ObjectHashSet<T> that)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toArray

public <T1> T1[] toArray(T1[] into)

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.Set<T>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.Set<T>

Overrides:

hashCode in class java.lang.Object

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.Set<T>