class CircuitGraph extends AnyRef
Graph-representation of a FIRRTL Circuit
Requires Middle FIRRTL Useful for writing design-specific custom-transforms that require connectivity information
- Source
- CircuitGraph.scala
- Alphabetic
- By Inheritance
- CircuitGraph
- 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
-
def
absolutePaths(mt: ModuleTarget): Seq[IsModule]
Return the absolute paths of all instances of this module.
Return the absolute paths of all instances of this module.
For example:
- Top instantiates a1 of A and a2 of A
- A instantiates b1 of B and b2 of B Then, absolutePaths of B will return:
- Seq(~Top|Top/a1:A/b1:B, ~Top|Top/a1:A/b2:B, ~Top|Top/a2:A/b1:B, ~Top|Top/a2:A/b2:B)
-
def
absoluteReferences(moduleTarget: ModuleTarget, kind: Kind): Seq[ReferenceTarget]
Return all absolute references to signals of the given kind directly contained in the module
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
connectionPath(source: ReferenceTarget, sink: ReferenceTarget): Seq[ReferenceTarget]
Return the sequence of nodes from source to sink, inclusive
-
def
deepReferences(kind: Kind, path: IsModule = ...): Seq[ReferenceTarget]
Return a reference to all nodes of given kind, contained in the referenced module/instance or any child instance Path can be either a module, or an instance
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
fanInSignals(sink: ReferenceTarget): Set[ReferenceTarget]
Given a signal, return the signals that drive it
-
def
fanOutSignals(source: ReferenceTarget): Set[ReferenceTarget]
Given a signal, return the signals that it drives
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
localReferences(path: IsModule, kind: Kind): Seq[ReferenceTarget]
Return a reference to all nodes of given kind, directly contained in the referenced module/instance Path can be either a module, or an instance
-
def
makeAbsolute(reference: ReferenceTarget): Seq[ReferenceTarget]
Given a reference, return all instances of that reference (i.e.
Given a reference, return all instances of that reference (i.e. with absolute paths)
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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()
This is the documentation for Firrtl.