Packages

class InstanceGraph extends AnyRef

A class representing the instance hierarchy of a working IR Circuit

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

Instance Constructors

  1. new InstanceGraph(c: Circuit)

    constructs an instance graph from a Circuit

    constructs an instance graph from a Circuit

    c

    the Circuit to analyze

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()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def findInstancesInHierarchy(module: String): Seq[Seq[WDefInstance]]

    Finds the absolute paths (each represented by a Seq of instances representing the chain of hierarchy) of all instances of a particular module.

    Finds the absolute paths (each represented by a Seq of instances representing the chain of hierarchy) of all instances of a particular module. Note that this includes one implicit instance of the top (main) module of the circuit. If the module is not instantiated within the hierarchy of the top module of the circuit, it will return Nil.

    module

    the name of the selected module

    returns

    a Seq[ Seq[WDefInstance] ] of absolute instance paths

  10. lazy val fullHierarchy: LinkedHashMap[WDefInstance, Seq[Seq[WDefInstance]]]

    A list of absolute paths (each represented by a Seq of instances) of all module instances in the Circuit.

  11. def getChildrenInstanceMap: Map[OfModule, Map[Instance, OfModule]]

    Given a circuit, returns a map from module name to a map in turn mapping instances names to corresponding module names

  12. def getChildrenInstanceOfModule: LinkedHashMap[String, LinkedHashSet[(Instance, OfModule)]]

    Given a circuit, returns a map from module name to children instance/module firrtl.annotations.TargetTokens

  13. def getChildrenInstances: LinkedHashMap[String, LinkedHashSet[WDefInstance]]

    Given a circuit, returns a map from module name to children instance/module definitions

  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. lazy val graph: DiGraph[WDefInstance]

    A directed graph showing the instance dependencies among modules in the circuit.

    A directed graph showing the instance dependencies among modules in the circuit. Every WDefInstance of a module has an edge to every WDefInstance arising from every instance statement in that module.

  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def lowestCommonAncestor(moduleA: Seq[WDefInstance], moduleB: Seq[WDefInstance]): Seq[WDefInstance]

    Finds the lowest common ancestor instances for two module names in a design

  19. val moduleMap: Map[String, DefModule]
  20. def moduleOrder: Seq[DefModule]

    Module order from highest module to leaf module

    Module order from highest module to leaf module

    returns

    sequence of modules in order from top to leaf

  21. lazy val modules: Set[OfModule]

    The set of all modules in the circuit

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. lazy val reachableModules: Set[OfModule]

    The set of all modules in the circuit reachable from the top module

  26. lazy val staticInstanceCount: Map[OfModule, Int]

    A count of the *static* number of instances of each module.

    A count of the *static* number of instances of each module. For any module other than the top (main) module, this is equivalent to the number of inst statements in the circuit instantiating each module, irrespective of the number of times (if any) the enclosing module appears in the hierarchy. Note that top module of the circuit has an associated count of one, even though it is never directly instantiated. Any modules *not* instantiated at all will have a count of zero.

  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. lazy val tour: EulerTour[Seq[WDefInstance]]

    An EulerTour representation of the DiGraph

  30. lazy val unreachableModules: Set[OfModule]

    The set of all modules *not* reachable in the circuit

  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped