Package soot.jimple.toolkits.scalar

Class ToppedSet<T>

java.lang.Object

soot.toolkits.scalar.AbstractFlowSet<T>

soot.jimple.toolkits.scalar.ToppedSet<T>

All Implemented Interfaces:

Iterable<T>, FlowSet<T>

public class ToppedSet<T>
extends AbstractFlowSet<T>

Represents information for flow analysis, adding a top element to a lattice. A FlowSet is an element of a lattice; this lattice might be described by a FlowUniverse. If add, remove, size, isEmpty, toList and contains are implemented, the lattice must be the powerset of some set.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isTop
protected FlowSet<T>	underlyingSet

Constructor Summary

Constructors

Constructor	Description
ToppedSet(FlowSet<T> under)

Method Summary

Modifier and Type	Method	Description
void	add(T obj)	Adds obj to this.
void	clear()	implemented, but *very* inefficient.
ToppedSet<T>	clone()	Clones the current FlowSet.
boolean	contains(T obj)	Returns true if this FlowSet contains obj.
void	copy(FlowSet<T> d)	Copies the current FlowSet into dest.
void	difference(FlowSet<T> o, FlowSet<T> d)	Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into dest.
FlowSet<T>	emptySet()	implemented, but inefficient.
boolean	equals(Object obj)
int	hashCode()
void	intersection(FlowSet<T> o, FlowSet<T> d)	Returns the intersection (meet) of this FlowSet and other, putting result into dest.
boolean	isEmpty()	Returns true if this FlowSet is the empty set.
boolean	isTop()
Iterator<T>	iterator()	returns an iterator over the elements of the flowSet.
void	remove(T obj)	Removes obj from this.
void	setTop(boolean top)
int	size()	Returns the size of the current FlowSet.
List<T>	toList()	Returns an unbacked list of contained objects for this FlowSet.
String	toString()
void	union(FlowSet<T> o, FlowSet<T> d)	Returns the union (join) of this FlowSet and other, putting result into dest.

Methods inherited from class soot.toolkits.scalar.AbstractFlowSet

add, difference, intersection, isSubSet, remove, union

Methods inherited from class java.lang.Object

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

Methods inherited from interface soot.toolkits.scalar.FlowSet

copyFreshToExisting

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

underlyingSet

protected final FlowSet<T> underlyingSet

isTop

protected boolean isTop

Constructor Detail

ToppedSet

public ToppedSet(FlowSet<T> under)

Method Detail

clone

public ToppedSet<T> clone()

Description copied from interface: FlowSet

Clones the current FlowSet.

Specified by:

clone in interface FlowSet<T>

Specified by:

clone in class AbstractFlowSet<T>

copy

public void copy(FlowSet<T> d)

Description copied from interface: FlowSet

Copies the current FlowSet into dest.

Specified by:

copy in interface FlowSet<T>

Overrides:

copy in class AbstractFlowSet<T>

emptySet

public FlowSet<T> emptySet()

Description copied from class: AbstractFlowSet

implemented, but inefficient.

Specified by:

emptySet in interface FlowSet<T>

Overrides:

emptySet in class AbstractFlowSet<T>

clear

public void clear()

Description copied from class: AbstractFlowSet

implemented, but *very* inefficient.

Specified by:

clear in interface FlowSet<T>

Overrides:

clear in class AbstractFlowSet<T>

union

public void union(FlowSet<T> o,
                  FlowSet<T> d)

Description copied from interface: FlowSet

Returns the union (join) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.

Specified by:

union in interface FlowSet<T>

Overrides:

union in class AbstractFlowSet<T>

intersection

public void intersection(FlowSet<T> o,
                         FlowSet<T> d)

Description copied from interface: FlowSet

Returns the intersection (meet) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.

Specified by:

intersection in interface FlowSet<T>

Overrides:

intersection in class AbstractFlowSet<T>

difference

public void difference(FlowSet<T> o,
                       FlowSet<T> d)

Description copied from interface: FlowSet

Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.

Specified by:

difference in interface FlowSet<T>

Overrides:

difference in class AbstractFlowSet<T>

isEmpty

public boolean isEmpty()

Description copied from interface: FlowSet

Returns true if this FlowSet is the empty set.

Specified by:

isEmpty in interface FlowSet<T>

Specified by:

isEmpty in class AbstractFlowSet<T>

size

public int size()

Description copied from interface: FlowSet

Returns the size of the current FlowSet.

Specified by:

size in interface FlowSet<T>

Specified by:

size in class AbstractFlowSet<T>

add

public void add(T obj)

Description copied from interface: FlowSet

Adds obj to this.

Specified by:

add in interface FlowSet<T>

Specified by:

add in class AbstractFlowSet<T>

remove

public void remove(T obj)

Description copied from interface: FlowSet

Removes obj from this.

Specified by:

remove in interface FlowSet<T>

Specified by:

remove in class AbstractFlowSet<T>

contains

public boolean contains(T obj)

Description copied from interface: FlowSet

Returns true if this FlowSet contains obj.

Specified by:

contains in interface FlowSet<T>

Specified by:

contains in class AbstractFlowSet<T>

toList

public List<T> toList()

Description copied from interface: FlowSet

Returns an unbacked list of contained objects for this FlowSet.

Specified by:

toList in interface FlowSet<T>

Specified by:

toList in class AbstractFlowSet<T>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractFlowSet<T>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractFlowSet<T>

toString

public String toString()

Overrides:

toString in class AbstractFlowSet<T>

iterator

public Iterator<T> iterator()

Description copied from interface: FlowSet

returns an iterator over the elements of the flowSet. Note that the iterator might be backed, and hence be faster in the creation, than doing toList().iterator().

Specified by:

iterator in interface FlowSet<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in class AbstractFlowSet<T>

setTop

public void setTop(boolean top)

isTop

public boolean isTop()