Packages

c

firrtl.graph

RenderDiGraph

class RenderDiGraph[T] extends AnyRef

Implement a really simple graphviz dot renderer for a digraph There are three main renderers currently -

T

The type of the Node.

Source
RenderDiGraph.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RenderDiGraph
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RenderDiGraph(diGraph: DiGraph[T], graphName: String = "", rankDir: String = "LR")

    diGraph

    The DiGraph to be rendered

    graphName

    Name of the graph, when shown in viewer

    rankDir

    Graph orientation, default is LR (left to right), most common alternative is TB (top to bottom)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def findOneLoop: Set[T]

    This finds a loop in a DiGraph if one exists and returns nodes

    This finds a loop in a DiGraph if one exists and returns nodes

    Note

    there is no way to currently to specify a particular loop

  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def renderNode(node: T): String

    override this to change the default way a node is displayed.

    override this to change the default way a node is displayed. Default is toString surrounded by double quotes This example changes the double quotes to brackets

    override def renderNode(node: String): String = { "[" + node + "]" }
  16. def showOnlyTheLoopAsDot: String

    Searches a DiGraph for a cycle.

    Searches a DiGraph for a cycle. The first one found will be rendered as a graph that contains only the nodes in the cycle plus the neighbors of those nodes.

    returns

    a string that can be used as input to the dot command, string is empty if no loop

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toDot: String

    Convert this graph into input for the graphviz dot program

    Convert this graph into input for the graphviz dot program

    returns

    A string representation of the digraph in dot notation

  19. def toDotRanked: String

    Convert this graph into input for the graphviz dot program.

    Convert this graph into input for the graphviz dot program. It tries to align nodes in columns based on their minimum distance to a source. Can also be faster and better behaved on large graphs

    returns

    string that is a graphviz digraph

  20. def toDotWithLoops(loopedNodes: Set[T], rankedNodes: ArrayBuffer[Seq[T]]): String

    Convert this graph into input for the graphviz dot program, but with a loop,if present, highlighted in red.

    Convert this graph into input for the graphviz dot program, but with a loop,if present, highlighted in red.

    returns

    string that is a graphviz digraph, but with loops highlighted

  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped