Package etomica.graph.traversal

Class AbstractTraversal

java.lang.Object

etomica.graph.traversal.AbstractTraversal

All Implemented Interfaces:

Traversal

Direct Known Subclasses:

Biconnected, BreadthFirst, DepthFirst

public abstract class AbstractTraversal
extends java.lang.Object
implements Traversal

Field Summary

Fields inherited from interface etomica.graph.traversal.Traversal

ERROR, ERROR_TRAVERSAL_EDGES, ERROR_TRAVERSAL_NODES, ERROR_TRAVERSAL_ROOT, NODE_NULL, STATUS_ARTICULATION_POINT, STATUS_START_BICOMPONENT, STATUS_START_COMPONENT, STATUS_VISITED_ALL, STATUS_VISITED_BICOMPONENT, STATUS_VISITED_COMPONENT, STATUS_VISITED_NODE

Constructor Summary

Constructors

Constructor	Description
AbstractTraversal()

Method Summary

Modifier and Type	Method	Description
protected void	error(byte errorID)
int	getGoal()
protected TraversalVisitor	getLocalVisitor()
int	getSeen()
protected void	localVisit(byte nodeID)
protected void	seen(byte nodeID)
protected boolean	seenAll()
void	setGoal(int bitmap)
protected void	setLocalVisitor(TraversalVisitor visitor)
void	setSeen(int bitmap)
protected boolean	setup(byte nodeID, Graph graph, TraversalVisitor visitor)
protected boolean	setup(Graph graph, TraversalVisitor visitor)
protected void	status(byte statusID)
byte	traverseAll(Graph graph, TraversalVisitor visitor)	The only reason to override this method is to change the node choice before traversing each component, or to traverse more complex components such as biconnected, K-connected, etc.
protected abstract void	traverseComponent(byte nodeID, Graph graph)
boolean	traverseComponent(byte nodeID, Graph graph, TraversalVisitor visitor)	There should be no reason to override this method.
protected boolean	unseenNeighbor(byte nodeID, byte neighborID)
protected void	visit(byte nodeID)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTraversal

public AbstractTraversal()

Method Detail

getLocalVisitor

protected TraversalVisitor getLocalVisitor()

getSeen

public int getSeen()

getGoal

public int getGoal()

setLocalVisitor

protected void setLocalVisitor(TraversalVisitor visitor)

setSeen

public void setSeen(int bitmap)

setGoal

public void setGoal(int bitmap)

error

protected void error(byte errorID)

seen

protected void seen(byte nodeID)

seenAll

protected boolean seenAll()

unseenNeighbor

protected boolean unseenNeighbor(byte nodeID,
                                 byte neighborID)

status

protected void status(byte statusID)

localVisit

protected void localVisit(byte nodeID)

visit

protected void visit(byte nodeID)

setup

protected boolean setup(Graph graph,
                        TraversalVisitor visitor)

setup

protected boolean setup(byte nodeID,
                        Graph graph,
                        TraversalVisitor visitor)

traverseComponent

protected abstract void traverseComponent(byte nodeID,
                                          Graph graph)

traverseComponent

public final boolean traverseComponent(byte nodeID,
                                       Graph graph,
                                       TraversalVisitor visitor)

There should be no reason to override this method.

Specified by:

traverseComponent in interface Traversal

Returns:

true if all nodes in the graph were seen during traversal

traverseAll

public byte traverseAll(Graph graph,
                        TraversalVisitor visitor)

The only reason to override this method is to change the node choice before traversing each component, or to traverse more complex components such as biconnected, K-connected, etc.

Specified by:

traverseAll in interface Traversal