sealed trait RenameMap extends AnyRef
Map old names to new names
These are mutable datastructures for convenience
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.
- Source
- RenameMap.scala
- Alphabetic
- By Inheritance
- RenameMap
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def _chained: Option[RenameMap]
- Attributes
- protected
- abstract def _underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
- Attributes
- protected
- abstract def circuitName: String
- Attributes
- protected
- abstract def doDistinct: Boolean
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ++(renameMap: RenameMap): RenameMap
Create new RenameMap that merges this and renameMap
- def ->[B](y: B): (RenameMap, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
- Attributes
- protected
- def andThen(next: RenameMap): RenameMap
- def apply(t: CompleteTarget): Seq[CompleteTarget]
Renames a CompleteTarget
Renames a CompleteTarget
- t
target to rename
- returns
renamed targets
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def completeRename(from: CompleteTarget, tos: Seq[CompleteTarget]): Unit
Fully rename
fromtotosFully rename
fromtotos- Attributes
- protected
- def ensuring(cond: (RenameMap) => Boolean, msg: => Any): RenameMap
- def ensuring(cond: (RenameMap) => Boolean): RenameMap
- def ensuring(cond: Boolean, msg: => Any): RenameMap
- def ensuring(cond: Boolean): RenameMap
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(key: Named): Option[Seq[Named]]
- def get(key: ComponentName): Option[Seq[ComponentName]]
- def get(key: ModuleName): Option[Seq[ModuleName]]
- def get(key: IsMember): Option[Seq[IsMember]]
Get renames of a IsMember
Get renames of a IsMember
- key
Target referencing the original member of the circuit
- returns
Optionally return sequence of targets that key remaps to
- def get(key: CompleteTarget): Option[Seq[CompleteTarget]]
Get renames of a CompleteTarget
Get renames of a CompleteTarget
- key
Target referencing the original circuit
- returns
Optionally return sequence of targets that key remaps to
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasChanges: Boolean
- returns
Whether this RenameMap has collected any changes
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def serialize: String
Visualize the RenameMap
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from RenameMap toStringFormat[RenameMap] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (RenameMap, B)
- Implicit
- This member is added by an implicit conversion from RenameMap toArrowAssoc[RenameMap] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt,SInt,Bool,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.