PropagationGraph (API Reference for wala 1.3.9)

java.lang.Object
- com.ibm.wala.ipa.callgraph.propagation.PropagationGraph

All Implemented Interfaces:

IFixedPointSystem<PointsToSetVariable>
```
public class PropagationGraph
extends Object
implements IFixedPointSystem<PointsToSetVariable>
```
A dataflow graph implementation specialized for propagation-based pointer analysis

Constructor Summary

Constructors
Constructor and Description

PropagationGraph()

Constructors
Constructor and Description
`PropagationGraph()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStatement(GeneralStatement<PointsToSetVariable> eq)`
`void`	`addStatement(IFixedPointStatement<PointsToSetVariable> statement)` Add a statement to the system
`void`	`addStatement(UnaryStatement<PointsToSetVariable> eq)`
`boolean`	`containsStatement(IFixedPointStatement<PointsToSetVariable> eq)`
`boolean`	`containsVariable(PointsToSetVariable v)`
`NumberedGraph<PointsToSetVariable>`	`getAssignmentGraph()` A graph of just the variables in the system.
`Graph<PointsToSetVariable>`	`getFilterAssignmentGraph()` A graph of just the variables in the system.
`Graph<PointsToSetVariable>`	`getFlowGraphIncludingImplicitConstraints()` NOTE: do not use this method unless you really know what you are doing.
`int`	`getNumberOfStatementsThatDef(PointsToSetVariable v)`
`int`	`getNumberOfStatementsThatUse(PointsToSetVariable v)` Note that this implementation consults the implicit relation for each and every operator cached.
`Iterator<AbstractStatement>`	`getStatements()` Return an Iterator of the `IFixedPointStatement`s in this system
`Iterator<AbstractStatement>`	`getStatementsThatDef(PointsToSetVariable v)`
`Iterator<AbstractStatement>`	`getStatementsThatUse(PointsToSetVariable v)`
`Iterator<PointsToSetVariable>`	`getVariables()` Return an Iterator of the variables in this graph
`void`	`performVerboseAction()`
`void`	`removeStatement(IFixedPointStatement<PointsToSetVariable> eq)` removes a given statement
`void`	`removeVariable(PointsToSetVariable p)`
`void`	`reorder()` reorder the statements in this system
`String`	`spaceReport()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PropagationGraph
```
public PropagationGraph()
```
- Method Detail
  - addStatement
```
public void addStatement(GeneralStatement<PointsToSetVariable> eq)
```
    Throws:
    
    IllegalArgumentException - if eq is null
  - addStatement
```
public void addStatement(UnaryStatement<PointsToSetVariable> eq)
                  throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - removeVariable
```
public void removeVariable(PointsToSetVariable p)
```
  - getStatements
```
public Iterator<AbstractStatement> getStatements()
```
    Description copied from interface: IFixedPointSystem
    
    Return an Iterator of the IFixedPointStatements in this system
    
    Specified by:
    
    getStatements in interface IFixedPointSystem<PointsToSetVariable>
    
    Returns:
    
    Iterator
  - removeStatement
```
public void removeStatement(IFixedPointStatement<PointsToSetVariable> eq)
                     throws IllegalArgumentException
```
    Description copied from interface: IFixedPointSystem
    
    removes a given statement
    
    Specified by:
    
    removeStatement in interface IFixedPointSystem<PointsToSetVariable>
    
    Throws:
    
    IllegalArgumentException
  - reorder
```
public void reorder()
```
    Description copied from interface: IFixedPointSystem
    
    reorder the statements in this system
    
    Specified by:
    
    reorder in interface IFixedPointSystem<PointsToSetVariable>
  - getStatementsThatUse
```
public Iterator<AbstractStatement> getStatementsThatUse(PointsToSetVariable v)
```
    Specified by:
    
    getStatementsThatUse in interface IFixedPointSystem<PointsToSetVariable>
    
    Returns:
    
    Iterator , the statements that use the variable
  - getStatementsThatDef
```
public Iterator<AbstractStatement> getStatementsThatDef(PointsToSetVariable v)
```
    Specified by:
    
    getStatementsThatDef in interface IFixedPointSystem<PointsToSetVariable>
    
    Returns:
    
    Iterator , the statements that def the variable
  - getNumberOfStatementsThatUse
```
public int getNumberOfStatementsThatUse(PointsToSetVariable v)
```
    Note that this implementation consults the implicit relation for each and every operator cached. This will be inefficient if there are many implicit operators.
    
    Specified by:
    
    getNumberOfStatementsThatUse in interface IFixedPointSystem<PointsToSetVariable>
    
    Throws:
    
    IllegalArgumentException - if v is null
  - getNumberOfStatementsThatDef
```
public int getNumberOfStatementsThatDef(PointsToSetVariable v)
```
    Specified by:
    
    getNumberOfStatementsThatDef in interface IFixedPointSystem<PointsToSetVariable>
  - getVariables
```
public Iterator<PointsToSetVariable> getVariables()
```
    Description copied from interface: IFixedPointSystem
    
    Return an Iterator of the variables in this graph
    
    Specified by:
    
    getVariables in interface IFixedPointSystem<PointsToSetVariable>
    
    Returns:
    
    Iterator
  - performVerboseAction
```
public void performVerboseAction()
```
  - containsStatement
```
public boolean containsStatement(IFixedPointStatement<PointsToSetVariable> eq)
                          throws IllegalArgumentException
```
    Specified by:
    
    containsStatement in interface IFixedPointSystem<PointsToSetVariable>
    
    Returns:
    
    true iff this system already contains an equation that is equal() to s
    
    Throws:
    
    IllegalArgumentException
  - containsVariable
```
public boolean containsVariable(PointsToSetVariable v)
```
    Specified by:
    
    containsVariable in interface IFixedPointSystem<PointsToSetVariable>
    
    Returns:
    
    true iff this system already contains a variable that is equal() to v.
  - addStatement
```
public void addStatement(IFixedPointStatement<PointsToSetVariable> statement)
                  throws IllegalArgumentException,
                         UnimplementedError
```
    Description copied from interface: IFixedPointSystem
    
    Add a statement to the system
    
    Specified by:
    
    addStatement in interface IFixedPointSystem<PointsToSetVariable>
    
    Throws:
    
    IllegalArgumentException
    
    UnimplementedError
  - getAssignmentGraph
```
public NumberedGraph<PointsToSetVariable> getAssignmentGraph()
```
    A graph of just the variables in the system. v1 -> v2 iff there exists an assignment equation e s.t. e uses v1 and e defs v2.
  - getFilterAssignmentGraph
```
public Graph<PointsToSetVariable> getFilterAssignmentGraph()
```
    A graph of just the variables in the system. v1 -> v2 iff there exists an Assingnment or Filter equation e s.t. e uses v1 and e defs v2.
  - getFlowGraphIncludingImplicitConstraints
```
public Graph<PointsToSetVariable> getFlowGraphIncludingImplicitConstraints()
```
    NOTE: do not use this method unless you really know what you are doing. Functionality is fragile and may not work in the future.
  - spaceReport
```
public String spaceReport()
```

Class PropagationGraph

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropagationGraph

Method Detail

addStatement

addStatement

removeVariable

getStatements

removeStatement

reorder

getStatementsThatUse

getStatementsThatDef

getNumberOfStatementsThatUse

getNumberOfStatementsThatDef

getVariables

performVerboseAction

containsStatement

containsVariable

addStatement

getAssignmentGraph

getFilterAssignmentGraph

getFlowGraphIncludingImplicitConstraints

spaceReport