Package com.ibm.wala.util.intset

Class BitVectorIntSet

java.lang.Object

com.ibm.wala.util.intset.BitVectorIntSet

All Implemented Interfaces:

IntSet, MutableIntSet, Serializable

public final class BitVectorIntSet
extends Object
implements MutableIntSet

A BitVector implementation of MutableIntSet.

Note that this is NOT a value with regard to hashCode and equals.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BitVectorIntSet()
BitVectorIntSet(@Nullable IntSet S)
BitVectorIntSet(BitVector v)

Method Summary

Modifier and Type	Method	Description
boolean	add(int i)	Add an integer value to this set.
boolean	addAll(@Nullable IntSet set)	Add all members of set to this.
boolean	addAllInIntersection(IntSet other, IntSet filter)
void	addAllOblivious(IntSet set)	this version of add all will likely be faster if the client doesn't care about the change or the population count.
void	clear()	remove all elements from this set
boolean	contains(int i)
boolean	containsAll(BitVectorIntSet other)
boolean	containsAny(IntSet set)
void	copySet(IntSet set)	Set the value of this to be the same as the value of set
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
BitVector	getBitVector()
BitVectorIntSet	intersection(IntSet that)	This implementation must not despoil the original value of "this"
void	intersectWith(IntSet set)	Intersect this with another set.
IntIterator	intIterator()	Use with extreme care; doesn't detect ConcurrentModificationExceptions
boolean	isEmpty()
boolean	isSubset(@Nullable IntSet that)
SparseIntSet	makeSparseCopy()
int	max()
int	nextSetBit(int n)
boolean	remove(int i)	Remove an integer from this set.
boolean	removeAll(BitVectorIntSet set)
boolean	sameValue(@Nullable IntSet that)
int	size()
SparseIntSet	toSparseIntSet()	TODO: optimize
String	toString()
IntSet	union(IntSet that)	This implementation must not despoil the original value of "this"

Methods inherited from class java.lang.Object

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

Constructor Detail

BitVectorIntSet

public BitVectorIntSet()

BitVectorIntSet

public BitVectorIntSet(BitVector v)

BitVectorIntSet

public BitVectorIntSet(@Nullable IntSet S)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

clear

public void clear()

Description copied from interface: MutableIntSet

remove all elements from this set

Specified by:

clear in interface MutableIntSet

copySet

public void copySet(IntSet set)
             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

addAll

public boolean addAll(@Nullable IntSet set)

Description copied from interface: MutableIntSet

Add all members of set to this.

Specified by:

addAll in interface MutableIntSet

Returns:

true iff the value of this changes.

addAllOblivious

public void addAllOblivious(IntSet set)
                     throws IllegalArgumentException

this version of add all will likely be faster if the client doesn't care about the change or the population count.

Throws:

IllegalArgumentException - if set == null

add

public boolean add(int i)

Description copied from interface: MutableIntSet

Add an integer value to this set.

Specified by:

add in interface MutableIntSet

Parameters:

i - integer to add

Returns:

true iff the value of this changes.

remove

public boolean remove(int i)

Description copied from interface: MutableIntSet

Remove an integer from this set.

Specified by:

remove in interface MutableIntSet

Parameters:

i - integer to remove

Returns:

true iff the value of this changes.

intersectWith

public void intersectWith(IntSet set)

Description copied from interface: MutableIntSet

Intersect this with another set.

Specified by:

intersectWith in interface MutableIntSet

intersection

public BitVectorIntSet intersection(IntSet that)

Description copied from interface: IntSet

This implementation must not despoil the original value of "this"

Specified by:

intersection in interface IntSet

Returns:

a new IntSet which is the intersection of this and that

See Also:

IntSet.intersection(com.ibm.wala.util.intset.IntSet)

union

public IntSet union(IntSet that)

Description copied from interface: IntSet

This implementation must not despoil the original value of "this"

Specified by:

union in interface IntSet

Returns:

a new IntSet containing all elements of this and that

See Also:

IntSet.union(com.ibm.wala.util.intset.IntSet)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IntSet

Returns:

true iff this set is empty

See Also:

IntSet.isEmpty()

size

public int size()

Specified by:

size in interface IntSet

Returns:

the number of elements in this set

See Also:

IntSet.size()

intIterator

public IntIterator intIterator()

Use with extreme care; doesn't detect ConcurrentModificationExceptions

Specified by:

intIterator in interface IntSet

Returns:

a perhaps more efficient iterator

foreach

public void foreach(IntSetAction action)

Description copied from interface: IntSet

Invoke an action on each element of the Set

Specified by:

foreach in interface IntSet

See Also:

IntSet.foreach(com.ibm.wala.util.intset.IntSetAction)

makeSparseCopy

public SparseIntSet makeSparseCopy()

foreachExcluding

public void foreachExcluding(IntSet X,
                             IntSetAction action)

Description copied from interface: IntSet

Invoke an action on each element of the Set, excluding elements of Set X

Specified by:

foreachExcluding in interface IntSet

See Also:

IntSet.foreach(com.ibm.wala.util.intset.IntSetAction)

contains

public boolean contains(int i)

Specified by:

contains in interface IntSet

Returns:

true iff this set contains integer i

max

public int max()

Specified by:

max in interface IntSet

Returns:

maximum integer in this set.

toString

public String toString()

Overrides:

toString in class Object

nextSetBit

public int nextSetBit(int n)

Returns:

min j >= n s.t get(j)

sameValue

public boolean sameValue(@Nullable IntSet that)
                  throws IllegalArgumentException,
                         UnimplementedError

Specified by:

sameValue in interface IntSet

Returns:

true iff this has the same value as that.

Throws:

IllegalArgumentException

UnimplementedError

See Also:

IntSet.sameValue(com.ibm.wala.util.intset.IntSet)

isSubset

@NullUnmarked
public boolean isSubset(@Nullable IntSet that)

Specified by:

isSubset in interface IntSet

Returns:

true iff this is a subset of that.

See Also:

IntSet.isSubset(com.ibm.wala.util.intset.IntSet)

getBitVector

public BitVector getBitVector()

toSparseIntSet

public SparseIntSet toSparseIntSet()

TODO: optimize

removeAll

public boolean removeAll(BitVectorIntSet set)

Throws:

IllegalArgumentException - if set is null

containsAny

public boolean containsAny(IntSet set)
                    throws IllegalArgumentException

Specified by:

containsAny in interface IntSet

Returns:

true iff this set contains integer i

Throws:

IllegalArgumentException

See Also:

IntSet.containsAny(com.ibm.wala.util.intset.IntSet)

addAllInIntersection

public boolean addAllInIntersection(IntSet other,
                                    IntSet filter)
                             throws IllegalArgumentException

Specified by:

addAllInIntersection in interface MutableIntSet

Throws:

IllegalArgumentException

containsAll

public boolean containsAll(BitVectorIntSet other)