SpaceEffGraphNode (Jikes RVM API)

java.lang.Object
- org.jikesrvm.compilers.opt.util.SpaceEffGraphNode

All Implemented Interfaces:

GraphNode

Direct Known Subclasses:

CoalesceGraph.Node, DepGraphNode, LSTNode, SortedGraphNode, ValueGraphVertex
```
public class SpaceEffGraphNode
extends Object
implements GraphNode
```
SpaceEffGraphNode is a generic graph node. Extend this to implement specific graph node types. A node has a list of out edges and a list of in edges. We maintain both to support bidirectional traversal of the graph.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SpaceEffGraphNode.GraphEdgeEnumeration<T extends GraphEdge>`
`(package private) static class`	`SpaceEffGraphNode.InEdgeEnumeration`
`(package private) static class`	`SpaceEffGraphNode.InNodeEnumeration`
`static class`	`SpaceEffGraphNode.OutEdgeEnumeration`
`(package private) static class`	`SpaceEffGraphNode.OutNodeEnumeration`

Field Summary

Fields
Modifier and Type	Field and Description
`protected SpaceEffGraphEdge`	`_inEdgeEnd`
`protected SpaceEffGraphEdge`	`_inEdgeStart`
`protected SpaceEffGraphEdge`	`_outEdgeEnd`
`protected SpaceEffGraphEdge`	`_outEdgeStart`
`(package private) static int`	`DFS_VISITED`
`protected int`	`info` The following word is used for various purposes.
`(package private) static int`	`INFO_MASK`
`(package private) static int`	`LOOP_HEADER`
`SpaceEffGraphNode`	`next` Links inlined from DoublyLinkedListElement.
`SpaceEffGraphNode`	`nextSorted`
`(package private) static int`	`ON_STACK`
`SpaceEffGraphNode`	`prev` Links inlined from DoublyLinkedListElement.
`(package private) static int`	`TOP_VISITED`

Constructor Summary

Constructors
Constructor and Description

SpaceEffGraphNode()

Constructors
Constructor and Description
`SpaceEffGraphNode()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_sortDFS(SpaceEffGraphNode header)`
`protected SpaceEffGraphNode`	`_sortRevTop(SpaceEffGraphNode tail)`
`protected SpaceEffGraphNode`	`_sortTop(SpaceEffGraphNode tail)`
`void`	`append(SpaceEffGraphNode n)` Append a given node after this node.
`protected void`	`appendInEdge(SpaceEffGraphEdge e)`
`protected void`	`appendOutEdge(SpaceEffGraphEdge e)`
`void`	`clearDfsVisited()`
`void`	`clearFlags()`
`(package private) void`	`clearIn()` clear the in set of edges
`void`	`clearInFlags()`
`void`	`clearLoopHeader()`
`void`	`clearOnStack()`
`(package private) void`	`clearOut()` clear the out set of edges
`void`	`clearOutFlags()`
`void`	`clearTopVisited()`
`void`	`deleteIn()`
`void`	`deleteOut()`
`void`	`deleteOut(SpaceEffGraphEdge e)`
`void`	`deleteOut(SpaceEffGraphNode node)`
`boolean`	`dfsVisited()`
`SpaceEffGraphEdge`	`findOutEdgeTo(SpaceEffGraphNode n)`
`SpaceEffGraphEdge`	`firstInEdge()`
`SpaceEffGraphNode`	`firstInNode()`
`SpaceEffGraphEdge`	`firstOutEdge()`
`SpaceEffGraphNode`	`firstOutNode()`
`boolean`	`flagsOn()`
`int`	`getIndex()` The index of this node in its graph.
`SpaceEffGraphNode`	`getNext()` Get the next node.
`int`	`getNumber()`
`int`	`getNumberOfIn()`
`int`	`getNumberOfOut()`
`SpaceEffGraphNode`	`getPrev()` Get the previous node.
`boolean`	`hasIn(GraphNode in)`
`boolean`	`hasOneIn()`
`boolean`	`hasOneIn(SpaceEffGraphNode inNode)`
`boolean`	`hasOneOut()`
`boolean`	`hasOneOut(SpaceEffGraphNode outNode)`
`boolean`	`hasOut(GraphNode out)`
`boolean`	`hasZeroIn()`
`boolean`	`hasZeroOut()`
`SpaceEffGraphNode.InEdgeEnumeration`	`inEdges()`
`Enumeration<GraphNode>`	`inNodes()` Get an enumeration of all the edges at which edges that point to this node are sourced.
`void`	`insertOut(SpaceEffGraphNode to)`
`void`	`insertOut(SpaceEffGraphNode to, SpaceEffGraphEdge e)`
`boolean`	`isLoopHeader()`
`boolean`	`onStack()`
`SpaceEffGraphNode.OutEdgeEnumeration`	`outEdges()`
`Enumeration<GraphNode>`	`outNodes()` Get an enumeration of all the edges to which edges sourced at this node point.
`boolean`	`pointsIn(SpaceEffGraphNode inNode)`
`boolean`	`pointsOut(SpaceEffGraphNode outNode)`
`void`	`printExtended()`
`void`	`printInEdges()`
`void`	`printInNodes()`
`void`	`printOutEdges()`
`void`	`printOutNodes()`
`(package private) void`	`printSorted()`
`SpaceEffGraphNode`	`remove()` Remove this node from the list.
`protected void`	`removeIn(SpaceEffGraphEdge InEdge)`
`protected SpaceEffGraphEdge`	`removeIn(SpaceEffGraphNode InNode)`
`protected void`	`removeOut(SpaceEffGraphEdge OutEdge)`
`protected SpaceEffGraphEdge`	`removeOut(SpaceEffGraphNode OutNode)`
`void`	`replaceInEdge(SpaceEffGraphEdge e1, SpaceEffGraphEdge e2)` Replaces the in edge matching e1 with e2.
`void`	`replaceOut(SpaceEffGraphNode oldOut, SpaceEffGraphNode newOut)`
`(package private) void`	`revertOuts()` Revert the sequence of out edges
`void`	`setDfsVisited()`
`void`	`setDfsVisitedOnStack()`
`void`	`setIndex(int i)`
`void`	`setLoopHeader()`
`void`	`setNumber(int value)`
`void`	`setOnStack()`
`void`	`setTopVisited()`
`void`	`sortDFS()`
`void`	`sortRevTop()`
`void`	`sortTop()`
`boolean`	`topVisited()`

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

Field Detail
- info
```
protected int info
```
  The following word is used for various purposes. The first 8 bits are used for flags, and the remaining 24 bits for any node information (node number, for example)
- DFS_VISITED
```
static final int DFS_VISITED
```
  See Also:
  
  Constant Field Values
- TOP_VISITED
```
static final int TOP_VISITED
```
  See Also:
  
  Constant Field Values
- ON_STACK
```
static final int ON_STACK
```
  See Also:
  
  Constant Field Values
- LOOP_HEADER
```
static final int LOOP_HEADER
```
  See Also:
  
  Constant Field Values
- INFO_MASK
```
static final int INFO_MASK
```
  See Also:
  
  Constant Field Values
- nextSorted
```
public SpaceEffGraphNode nextSorted
```
- _outEdgeStart
```
protected SpaceEffGraphEdge _outEdgeStart
```
- _outEdgeEnd
```
protected SpaceEffGraphEdge _outEdgeEnd
```
- _inEdgeStart
```
protected SpaceEffGraphEdge _inEdgeStart
```
- _inEdgeEnd
```
protected SpaceEffGraphEdge _inEdgeEnd
```
- prev
```
public SpaceEffGraphNode prev
```
  Links inlined from DoublyLinkedListElement.
- next
```
public SpaceEffGraphNode next
```
  Links inlined from DoublyLinkedListElement.

Constructor Detail
- SpaceEffGraphNode
```
public SpaceEffGraphNode()
```

Method Detail

dfsVisited
```
public final boolean dfsVisited()
```

topVisited
```
public final boolean topVisited()
```

onStack
```
public final boolean onStack()
```

flagsOn
```
public final boolean flagsOn()
```

isLoopHeader
```
public final boolean isLoopHeader()
```

setDfsVisited
```
public final void setDfsVisited()
```

setTopVisited
```
public final void setTopVisited()
```

setOnStack
```
public final void setOnStack()
```

setDfsVisitedOnStack

public final void setDfsVisitedOnStack()

setLoopHeader
```
public final void setLoopHeader()
```

clearDfsVisited
```
public final void clearDfsVisited()
```

clearTopVisited
```
public final void clearTopVisited()
```

clearOnStack
```
public final void clearOnStack()
```

clearFlags
```
public final void clearFlags()
```

clearLoopHeader
```
public final void clearLoopHeader()
```

setNumber

public final void setNumber(int value)

getNumber
```
public final int getNumber()
```

getIndex
```
public final int getIndex()
```
Description copied from interface: GraphNode

The index of this node in its graph. In general, this can e anarbitrary number, but after a call to Graph.compactNodeNumbering the nodes of a graph should be numbered 0 thru (# of nodes in graph - 1).

Specified by:

getIndex in interface GraphNode

Returns:

the index of this node in its graph.

setIndex
```
public final void setIndex(int i)
```
Specified by:

setIndex in interface GraphNode

firstInEdge

public final SpaceEffGraphEdge firstInEdge()

firstOutEdge

public final SpaceEffGraphEdge firstOutEdge()

firstInNode

public final SpaceEffGraphNode firstInNode()

firstOutNode

public final SpaceEffGraphNode firstOutNode()

clearIn
```
final void clearIn()
```
clear the in set of edges

clearOut
```
final void clearOut()
```
clear the out set of edges

deleteIn
```
public final void deleteIn()
```

deleteOut
```
public final void deleteOut()
```

getNumberOfIn
```
public final int getNumberOfIn()
```

getNumberOfOut
```
public final int getNumberOfOut()
```

hasZeroOut
```
public final boolean hasZeroOut()
```

hasZeroIn
```
public final boolean hasZeroIn()
```

hasOneOut
```
public final boolean hasOneOut()
```

hasOneIn
```
public final boolean hasOneIn()
```

pointsIn

public final boolean pointsIn(SpaceEffGraphNode inNode)

pointsOut

public final boolean pointsOut(SpaceEffGraphNode outNode)

hasIn

public final boolean hasIn(GraphNode in)

hasOut

public final boolean hasOut(GraphNode out)

findOutEdgeTo

public final SpaceEffGraphEdge findOutEdgeTo(SpaceEffGraphNode n)

replaceInEdge
```
public final void replaceInEdge(SpaceEffGraphEdge e1,
                                SpaceEffGraphEdge e2)
```
Replaces the in edge matching e1 with e2. maintains the ordering of edges

Parameters:

e1 - original edge

e2 - new edge TODO YUCK: this data structure is messy. I assume this is in the name of efficiency, but it makes control flow graph manipulations a real pain. (SJF)

hasOneIn
```
public final boolean hasOneIn(SpaceEffGraphNode inNode)
```
Parameters:

inNode - the node that might be the single predecessor

Returns:

true if the node is the single predecessor of this node

hasOneOut
```
public final boolean hasOneOut(SpaceEffGraphNode outNode)
```
Parameters:

outNode - the node that might be the single successor

Returns:

true if the node is the single successor of this node

replaceOut

public final void replaceOut(SpaceEffGraphNode oldOut,
                             SpaceEffGraphNode newOut)

insertOut

public final void insertOut(SpaceEffGraphNode to,
                            SpaceEffGraphEdge e)

insertOut

public final void insertOut(SpaceEffGraphNode to)

deleteOut

public final void deleteOut(SpaceEffGraphNode node)

deleteOut

public final void deleteOut(SpaceEffGraphEdge e)

sortDFS
```
public final void sortDFS()
```

_sortDFS

protected final void _sortDFS(SpaceEffGraphNode header)

clearOutFlags
```
public final void clearOutFlags()
```

clearInFlags
```
public final void clearInFlags()
```

sortTop
```
public final void sortTop()
```

_sortTop

protected final SpaceEffGraphNode _sortTop(SpaceEffGraphNode tail)

sortRevTop
```
public final void sortRevTop()
```

_sortRevTop

protected final SpaceEffGraphNode _sortRevTop(SpaceEffGraphNode tail)

printSorted
```
final void printSorted()
```

revertOuts
```
final void revertOuts()
```
Revert the sequence of out edges

inEdges

public final SpaceEffGraphNode.InEdgeEnumeration inEdges()

outEdges

public final SpaceEffGraphNode.OutEdgeEnumeration outEdges()

inNodes
```
public final Enumeration<GraphNode> inNodes()
```
Description copied from interface: GraphNode

Get an enumeration of all the edges at which edges that point to this node are sourced.

Specified by:

inNodes in interface GraphNode

Returns:

an enumeration of all the edges at which edges that point to this node are sourced.

outNodes
```
public final Enumeration<GraphNode> outNodes()
```
Description copied from interface: GraphNode

Get an enumeration of all the edges to which edges sourced at this node point.

Specified by:

outNodes in interface GraphNode

Returns:

an enumeration of all the edges to which edges sourced at this node point.

printInEdges
```
public void printInEdges()
```

printOutEdges
```
public void printOutEdges()
```

printInNodes
```
public void printInNodes()
```

printOutNodes
```
public void printOutNodes()
```

printExtended
```
public void printExtended()
```

appendInEdge

protected final void appendInEdge(SpaceEffGraphEdge e)

appendOutEdge

protected final void appendOutEdge(SpaceEffGraphEdge e)

removeIn

protected final void removeIn(SpaceEffGraphEdge InEdge)

removeIn

protected final SpaceEffGraphEdge removeIn(SpaceEffGraphNode InNode)

removeOut

protected final void removeOut(SpaceEffGraphEdge OutEdge)

removeOut

protected final SpaceEffGraphEdge removeOut(SpaceEffGraphNode OutNode)

getNext

public final SpaceEffGraphNode getNext()

Get the next node.

Returns:: next node

getPrev
```
public final SpaceEffGraphNode getPrev()
```
Get the previous node.

Returns:

previous node

append
```
public final void append(SpaceEffGraphNode n)
```
Append a given node after this node.

Parameters:

n - the node to append

remove
```
public final SpaceEffGraphNode remove()
```
Remove this node from the list.

Returns:

the next node in the list

Class SpaceEffGraphNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

info

DFS_VISITED

TOP_VISITED

ON_STACK

LOOP_HEADER

INFO_MASK

nextSorted

_outEdgeStart

_outEdgeEnd

_inEdgeStart

_inEdgeEnd

prev

next

Constructor Detail

SpaceEffGraphNode

Method Detail

dfsVisited

topVisited

onStack

flagsOn

isLoopHeader

setDfsVisited

setTopVisited

setOnStack

setDfsVisitedOnStack

setLoopHeader

clearDfsVisited

clearTopVisited

clearOnStack

clearFlags

clearLoopHeader

setNumber

getNumber

getIndex

setIndex

firstInEdge

firstOutEdge

firstInNode

firstOutNode

clearIn

clearOut

deleteIn

deleteOut

getNumberOfIn

getNumberOfOut

hasZeroOut

hasZeroIn

hasOneOut

hasOneIn

pointsIn

pointsOut

hasIn

hasOut

findOutEdgeTo

replaceInEdge

hasOneIn

hasOneOut

replaceOut

insertOut

insertOut

deleteOut

deleteOut

sortDFS

_sortDFS

clearOutFlags

clearInFlags

sortTop

_sortTop

sortRevTop

_sortRevTop

printSorted

revertOuts

inEdges