Packages

class InstanceKeyGraph extends AnyRef

A class representing the instance hierarchy of firrtl Circuit This is a faster version of the old InstanceGraph which only uses pairs of InstanceName and Module name as vertex keys instead of using WDefInstance which will hash the instance type causing some performance issues.

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

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[InstanceKey]]

    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. def fullHierarchy: LinkedHashMap[InstanceKey, Seq[Seq[InstanceKey]]]

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

  11. def getChildInstanceMap: LinkedHashMap[OfModule, LinkedHashMap[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 getChildInstances: Seq[(String, Seq[InstanceKey])]

    Returns a sequence that can be turned into a map from module name to instances defined in said module.

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def graph: DiGraph[InstanceKey]

    returns the underlying graph

  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def moduleMap: Map[String, DefModule]

    maps module names to the DefModule node

  18. def moduleOrder: Seq[DefModule]

    Module order from highest module to leaf module

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def reachableModules: Seq[OfModule]

    All modules in the circuit reachable from the top module

  23. def 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.

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def top: InstanceKey

    returns the key to the top (main) module

  27. def unreachableModules: Seq[OfModule]

    All modules *not* reachable from the top module of the circuit

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped