Package com.ibm.wala.util.intset

Class SparseLongSet

java.lang.Object

com.ibm.wala.util.intset.SparseLongSet

All Implemented Interfaces:

LongSet

Direct Known Subclasses:

MutableSparseLongSet

public class SparseLongSet
extends Object
implements LongSet

A sparse ordered, duplicate-free, fully-encapsulated set of longs; not necessary mutable

Field Summary

Fields

Modifier and Type	Field	Description
protected long[]	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
	SparseLongSet()	Subclasses should use this with extreme care.
protected	SparseLongSet(int size)
protected	SparseLongSet(long[] backingArray)	Subclasses should use this with extreme care.
	SparseLongSet(IntSet S)
protected	SparseLongSet(SparseLongSet S)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

elements

protected long[] elements

The backing store of int arrays

size

protected int size

The number of entries in the backing store that are valid.

Constructor Details

SparseLongSet

protected SparseLongSet(int size)

SparseLongSet

protected SparseLongSet(long[] backingArray)

Subclasses should use this with extreme care. Do not allow the backing array to escape elsewhere.

SparseLongSet

@NullUnmarked
public SparseLongSet()

Subclasses should use this with extreme care.

SparseLongSet

protected SparseLongSet(SparseLongSet S)

SparseLongSet

public SparseLongSet(IntSet S)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

contains

public final boolean contains(long x)

Does this set contain value x?

Specified by:

contains in interface LongSet

Returns:

true iff this set contains long i

See Also:

• IntSet.contains(int)

getIndex

public final int getIndex(long x)

Returns:

index i s.t. elements[i] == x, or -1 if not found.

size

public final int size()

Specified by:

size in interface LongSet

Returns:

the number of elements in this set

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface LongSet

Returns:

true iff this set is empty

elementAt

public final long elementAt(int idx)
                     throws NoSuchElementException

Throws:

NoSuchElementException

sameValue

public boolean sameValue(LongSet that)
                  throws IllegalArgumentException,
UnimplementedError

Specified by:

sameValue in interface LongSet

Returns:

true iff this has the same value as that.

Throws:

IllegalArgumentException

UnimplementedError

diff

public static SparseLongSet diff(SparseLongSet A,
 SparseLongSet B)

Compute the asymmetric difference of two sets, a \ b.

Throws:

IllegalArgumentException - if A is null

toString

public String toString()

Overrides:

toString in class Object

parseLongArray

public static long[] parseLongArray(String str)
                             throws NumberFormatException,
IllegalArgumentException

Reverse of toString(): "{2,3}" -> [2,3]

Throws:

IllegalArgumentException - if str is null

NumberFormatException

singleton

public static SparseLongSet singleton(int i)

pair

public static SparseLongSet pair(long i,
 long j)

intersection

public @Nullable LongSet intersection(LongSet that)
                               throws IllegalArgumentException,
UnimplementedError

Description copied from interface: LongSet

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

Specified by:

intersection in interface LongSet

Returns:

a new IntSet which is the intersection of this and that

Throws:

IllegalArgumentException

UnimplementedError

See Also:

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

longIterator

public LongIterator longIterator()

Specified by:

longIterator in interface LongSet

Returns:

a perhaps more efficient iterator

See Also:

• IntSet.intIterator()

foreach

public void foreach(LongSetAction action)

Description copied from interface: LongSet

Invoke an action on each element of the Set

Specified by:

foreach in interface LongSet

foreachExcluding

public void foreachExcluding(LongSet X,
 LongSetAction action)

Description copied from interface: LongSet

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

Specified by:

foreachExcluding in interface LongSet

max

public final long max()
               throws IllegalStateException

Specified by:

max in interface LongSet

Returns:

the largest element in the set

Throws:

IllegalStateException

add

public static SparseLongSet add(SparseLongSet s,
 int j)

Returns:

a new sparse int set which adds j to s

isSubset

public boolean isSubset(LongSet that)
                 throws IllegalArgumentException,
UnimplementedError

Specified by:

isSubset in interface LongSet

Returns:

true iff this is a subset of that.

Throws:

IllegalArgumentException

UnimplementedError

See Also:

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

containsAny

public boolean containsAny(LongSet set)

Specified by:

containsAny in interface LongSet

Returns:

true iff this set contains integer i

See Also:

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

containsAny

public boolean containsAny(SparseLongSet set)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException