Package pascal.taie.util.collection

Class AbstractHybridSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

pascal.taie.util.collection.AbstractSetEx<E>

pascal.taie.util.collection.AbstractHybridSet<E>

Type Parameters:

E - type of elements

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>, SetEx<E>, Copyable<SetEx<E>>

Direct Known Subclasses:

HybridBitSet, HybridHashSet, HybridIndexableSet, HybridLinkedHashSet

public abstract class AbstractHybridSet<E>
extends AbstractSetEx<E>
implements Serializable

This set supports hybrid of two set implementations, where one is efficient for small set and another one is efficient for large set.

When the number of elements contained in this set succeeds a threshold, it will automatically upgrade the set implementation to the one that is efficient for large set. Moreover, empty sets and singleton sets are represented with just a reference.

Elements added to this set cannot be null.

By default, this set uses ArraySet for small set.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isLargeSet	Whether the set implementation is the one for large set.
protected Set<E>	set	The set containing the elements.
protected E	singleton	The singleton value.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHybridSet()	Constructs a new hybrid set.
protected	AbstractHybridSet(Collection<E> c)	Constructs a new hybrid set from the given collection.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object obj)
protected int	getThreshold()
int	hashCode()
boolean	isEmpty()
Iterator<E>	iterator()
protected abstract Set<E>	newLargeSet(int initialCapacity)	Creates a large set.
protected Set<E>	newSmallSet()	Creates a small set.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class pascal.taie.util.collection.AbstractSetEx

addAllDiff, copy, hasOverlapWith, newSet

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Field Details

singleton

protected E singleton

The singleton value. Null if not a singleton.

set

protected Set<E> set

The set containing the elements. Null if the set is not used.

isLargeSet

protected boolean isLargeSet

Whether the set implementation is the one for large set.

Constructor Details

AbstractHybridSet

protected AbstractHybridSet()

Constructs a new hybrid set.

AbstractHybridSet

protected AbstractHybridSet(Collection<E> c)

Constructs a new hybrid set from the given collection.

Method Details

getThreshold

protected int getThreshold()

Returns:

the threshold between sizes of small set and large set. When number of elements exceeds the threshold, set should be upgraded to large set.

newSmallSet

protected Set<E> newSmallSet()

Creates a small set.

newLargeSet

protected abstract Set<E> newLargeSet(int initialCapacity)

Creates a large set.

Parameters:

initialCapacity - initial capacity of the resulting set.

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

addAll

public boolean addAll(@Nonnull
 Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

Overrides:

addAll in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

Overrides:

containsAll in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

iterator

@Nonnull
public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

Overrides:

removeAll in class AbstractSet<E>

retainAll

public boolean retainAll(@Nonnull
 Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

Overrides:

retainAll in class AbstractCollection<E>

toArray

@Nonnull
public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

@Nonnull
public <T> T[] toArray(@Nonnull
 T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface Set<E>

Overrides:

hashCode in class AbstractSet<E>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class AbstractSet<E>