Class MutableSparseIntSet

java.lang.Object

com.ibm.wala.util.intset.SparseIntSet

com.ibm.wala.util.intset.MutableSparseIntSet

All Implemented Interfaces:

IntSet, MutableIntSet, Serializable

Direct Known Subclasses:

TunedMutableSparseIntSet

public class MutableSparseIntSet
extends SparseIntSet
implements MutableIntSet

A sparse ordered, mutable duplicate-free, fully-encapsulated set of integers. Instances are not canonical, except for EMPTY.

This implementation will be inefficient if these sets get large.

TODO: even for small sets, we probably want to work on this to reduce the allocation activity.

See Also:

• Serialized Form

Field Summary

Fields inherited from class SparseIntSet

elements, size

Modifier and Type	Field	Description
protected int[]	elements	The backing store of int arrays
protected int	size	The number of entries in the backing store that are valid.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MutableSparseIntSet()
protected	MutableSparseIntSet(int[] backingStore)
protected	MutableSparseIntSet(@Nullable IntSet set)

Method Summary

Modifier and Type	Method	Description
boolean	add(int value)	Add an integer value to this set.
boolean	addAll(@Nullable SparseIntSet that)	Add all elements from another int set.
boolean	addAll(IntSet set)	Add all elements from another int set.
boolean	addAllInIntersection(IntSet other, IntSet filter)
void	clear()	remove all elements from this set
void	copySet(@Nullable IntSet that)	Set the value of this to be the same as the value of set
static MutableSparseIntSet	createMutableSparseIntSet(int initialCapacity)
static MutableSparseIntSet	diff(MutableSparseIntSet A, MutableSparseIntSet B)
float	getExpansionFactor()
int	getInitialNonEmptySize()
void	intersectWith(IntSet set)	Intersect this with another set.
void	intersectWith(SparseIntSet that)
static MutableSparseIntSet	make(@Nullable IntSet set)
static MutableSparseIntSet	makeEmpty()
boolean	remove(int value)	Remove an integer from this set.
void	removeAll(BitVectorIntSet v)
void	removeAll(MutableSparseIntSet set)	TODO optimize
<T extends BitVectorBase<T>> void	removeAll(T v)

Methods inherited from class SparseIntSet

add, contains, containsAny, containsAny, diff, diffInternal, elementAt, foreach, foreachExcluding, getIndex, intersection, intIterator, isEmpty, isSubset, max, pair, parseIntArray, sameValue, singleton, size, toIntArray, toString, union

Modifier and Type	Method	Description
static SparseIntSet	add(SparseIntSet s, int j)
final boolean	contains(int x)	Does this set contain value x?
boolean	containsAny(IntSet set)
boolean	containsAny(SparseIntSet set)
static SparseIntSet	diff(SparseIntSet A, SparseIntSet B)	Compute the asymmetric difference of two sets, a \ b.
static int[]	diffInternal(SparseIntSet A, SparseIntSet B)
final int	elementAt(int idx)
void	foreach(IntSetAction action)	Invoke an action on each element of the Set
void	foreachExcluding(IntSet X, IntSetAction action)	Invoke an action on each element of the Set, excluding elements of Set X
final int	getIndex(int x)
IntSet	intersection(IntSet that)	This implementation must not despoil the original value of "this"
IntIterator	intIterator()
final boolean	isEmpty()
boolean	isSubset(@Nullable IntSet that)
final int	max()
static SparseIntSet	pair(int i, int j)
static int[]	parseIntArray(String str)	Reverse of toString(): "{2,3}" -> [2,3]
boolean	sameValue(IntSet that)
static SparseIntSet	singleton(int i)
final int	size()
int[]	toIntArray()
String	toString()
IntSet	union(IntSet that)	This implementation must not despoil the original value of "this"

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MutableSparseIntSet

protected MutableSparseIntSet(@Nullable IntSet set)

MutableSparseIntSet

protected MutableSparseIntSet(int[] backingStore)

MutableSparseIntSet

protected MutableSparseIntSet()

Method Details

clear

public void clear()

Description copied from interface: MutableIntSet

remove all elements from this set

Specified by:

clear in interface MutableIntSet

remove

@NullUnmarked
public boolean remove(int value)

Description copied from interface: MutableIntSet

Remove an integer from this set.

Specified by:

remove in interface MutableIntSet

Parameters:

value - integer to remove

Returns:

true iff the value of this changes.

getInitialNonEmptySize

public int getInitialNonEmptySize()

getExpansionFactor

public float getExpansionFactor()

add

public boolean add(int value)

Description copied from interface: MutableIntSet

Add an integer value to this set.

Specified by:

add in interface MutableIntSet

Parameters:

value - integer to add

Returns:

true iff this value changes

copySet

@NullUnmarked
public void copySet(@Nullable IntSet that)
             throws IllegalArgumentException

Description copied from interface: MutableIntSet

Set the value of this to be the same as the value of set

Specified by:

copySet in interface MutableIntSet

Throws:

IllegalArgumentException - if that == null

intersectWith

public void intersectWith(IntSet set)

Description copied from interface: MutableIntSet

Intersect this with another set.

Specified by:

intersectWith in interface MutableIntSet

intersectWith

@NullUnmarked
public void intersectWith(SparseIntSet that)

addAll

public boolean addAll(IntSet set)
               throws IllegalArgumentException

Add all elements from another int set.

Specified by:

addAll in interface MutableIntSet

Returns:

true iff this set changes

Throws:

IllegalArgumentException - if set == null

addAll

public boolean addAll(@Nullable SparseIntSet that)

Add all elements from another int set.

Returns:

true iff this set changes

removeAll

public void removeAll(BitVectorIntSet v)

removeAll

public <T extends BitVectorBase<T>> void removeAll(T v)

removeAll

public void removeAll(MutableSparseIntSet set)

TODO optimize

Throws:

IllegalArgumentException - if set is null

addAllInIntersection

public boolean addAllInIntersection(IntSet other,
 IntSet filter)

Specified by:

addAllInIntersection in interface MutableIntSet

diff

public static MutableSparseIntSet diff(MutableSparseIntSet A,
 MutableSparseIntSet B)

make

public static MutableSparseIntSet make(@Nullable IntSet set)

makeEmpty

public static MutableSparseIntSet makeEmpty()

createMutableSparseIntSet

public static MutableSparseIntSet createMutableSparseIntSet(int initialCapacity)
                                                     throws IllegalArgumentException

Throws:

IllegalArgumentException