edu.byu.ece.graph
Interface Edge

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
EdifPortRefEdge
All Known Implementing Classes:
BasicEdge, EdifCellInstanceCollectionLink, EdifCellInstanceEdge, SourceEPREdge

public interface Edge
extends java.io.Serializable

An interface representing a mathematical edge between two objects.

An edge object contains a source object and a sink object. The actual implementation of this interface can return an object of any type.

Author:
Brian Pratt

Method Summary
 java.lang.Object getSink()
          Return the sink object of a mathematical edge.
 java.lang.Object getSource()
          Return the source object of a mathematical edge.
 Edge invert()
          Return a new edge object that is the inverse of this object.
 

Method Detail

getSource

java.lang.Object getSource()
Return the source object of a mathematical edge.

Returns:
Source object.

getSink

java.lang.Object getSink()
Return the sink object of a mathematical edge.

Returns:
sink object.

invert

Edge invert()
Return a new edge object that is the inverse of this object. The resulting Edge will swap the source and sink objects.

Returns:
sink object.