Class/Object

firrtl.analyses

InstanceKeyGraph

Related Docs: object InstanceKeyGraph | package analyses

Permalink

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
AnyRef, Any
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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def findInstancesInHierarchy(module: String): Seq[Seq[InstanceKey]]

    Permalink

    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

  9. def fullHierarchy: LinkedHashMap[InstanceKey, Seq[Seq[InstanceKey]]]

    Permalink

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

  10. def getChildInstanceMap: LinkedHashMap[OfModule, LinkedHashMap[Instance, OfModule]]

    Permalink

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

  11. def getChildInstances: Seq[(String, Seq[InstanceKey])]

    Permalink

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

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  13. def graph: DiGraph[InstanceKey]

    Permalink

    returns the underlying graph

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. def moduleMap: Map[String, DefModule]

    Permalink

    maps module names to the DefModule node

  17. def moduleOrder: Seq[DefModule]

    Permalink

    Module order from highest module to leaf module

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  21. def reachableModules: Seq[OfModule]

    Permalink

    All modules in the circuit reachable from the top module

  22. def staticInstanceCount: Map[OfModule, Int]

    Permalink

    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.

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. def top: InstanceKey

    Permalink

    returns the key to the top (main) module

  26. def unreachableModules: Seq[OfModule]

    Permalink

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

  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped