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
- Alphabetic
- By Inheritance
- InstanceKeyGraph
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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.
-
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
-
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.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
graph: DiGraph[InstanceKey]
returns the underlying graph
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
moduleMap: Map[String, DefModule]
maps module names to the DefModule node
-
def
moduleOrder: Seq[DefModule]
Module order from highest module to leaf module
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
reachableModules: Seq[OfModule]
All modules in the circuit reachable from the top module
-
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
top: InstanceKey
returns the key to the top (main) module
-
def
unreachableModules: Seq[OfModule]
All modules *not* reachable from the top module of the circuit
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
This is the documentation for Firrtl.