Packages

  • package root

    This is the documentation for Chisel.

    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, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package firrtl
    Definition Classes
    root
  • package renamemap
    Definition Classes
    firrtl
  • MutableRenameMap

final class MutableRenameMap extends RenameMap

Annotations
@deprecated
Deprecated

(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.

Source
RenameMap.scala
Linear Supertypes
RenameMap, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableRenameMap
  2. RenameMap
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toany2stringadd[MutableRenameMap] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ++(renameMap: RenameMap): RenameMap

    Create new RenameMap that merges this and renameMap

    Create new RenameMap that merges this and renameMap

    Definition Classes
    RenameMap
  5. def ->[B](y: B): (MutableRenameMap, B)
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toArrowAssoc[MutableRenameMap] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. val _chained: Option[RenameMap]
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  8. def _recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
    Attributes
    protected
    Definition Classes
    RenameMap
  9. val _underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  10. def addMap(map: Map[Named, Seq[Named]]): Unit
  11. def andThen(next: RenameMap): RenameMap

    Chain a RenameMap with this RenameMap

    Chain a RenameMap with this RenameMap

    next

    the map to chain with this map

    Definition Classes
    RenameMap
    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  12. def apply(t: CompleteTarget): Seq[CompleteTarget]

    Renames a CompleteTarget

    Renames a CompleteTarget

    t

    target to rename

    returns

    renamed targets

    Definition Classes
    RenameMap
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. val circuitName: String
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def completeRename(from: CompleteTarget, tos: Seq[CompleteTarget]): Unit

    Fully rename from to tos

    Fully rename from to tos

    Attributes
    protected
    Definition Classes
    RenameMap
  17. def delete(name: ComponentName): Unit
  18. def delete(name: ModuleName): Unit
  19. def delete(name: CompleteTarget): Unit

    Records that a CompleteTarget is deleted

  20. val doDistinct: Boolean
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  21. def ensuring(cond: (MutableRenameMap) => Boolean, msg: => Any): MutableRenameMap
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toEnsuring[MutableRenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (MutableRenameMap) => Boolean): MutableRenameMap
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toEnsuring[MutableRenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: => Any): MutableRenameMap
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toEnsuring[MutableRenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): MutableRenameMap
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toEnsuring[MutableRenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  28. def get(key: Named): Option[Seq[Named]]
    Definition Classes
    RenameMap
  29. def get(key: ComponentName): Option[Seq[ComponentName]]
    Definition Classes
    RenameMap
  30. def get(key: ModuleName): Option[Seq[ModuleName]]
    Definition Classes
    RenameMap
  31. 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

    Definition Classes
    RenameMap
  32. 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

    Definition Classes
    RenameMap
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def hasChanges: Boolean

    returns

    Whether this RenameMap has collected any changes

    Definition Classes
    RenameMap
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. def record(from: IsMember, tos: Seq[IsMember]): Unit

    Record that the from IsMember is renamed to another sequence of IsMembers

    Record that the from IsMember is renamed to another sequence of IsMembers

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  41. def record(from: IsMember, to: IsMember): Unit

    Record that the from Member is renamed to another IsMember

    Record that the from Member is renamed to another IsMember

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  42. def recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit

    Records that the keys in map are also renamed to their corresponding value seqs.

    Records that the keys in map are also renamed to their corresponding value seqs. Only (IsMember -> Seq[ IsMember ]) key/value allowed

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  43. def rename(from: ComponentName, tos: Seq[ComponentName]): Unit
  44. def rename(from: ComponentName, to: ComponentName): Unit
  45. def rename(from: Named, tos: Seq[Named]): Unit
  46. def rename(from: Named, to: Named): Unit
  47. def serialize: String

    Visualize the RenameMap

    Visualize the RenameMap

    Definition Classes
    RenameMap
  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toStringFormat[MutableRenameMap] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (MutableRenameMap, B)
    Implicit
    This member is added by an implicit conversion from MutableRenameMap toArrowAssoc[MutableRenameMap] 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.

Inherited from RenameMap

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromMutableRenameMap to any2stringadd[MutableRenameMap]

Inherited by implicit conversion StringFormat fromMutableRenameMap to StringFormat[MutableRenameMap]

Inherited by implicit conversion Ensuring fromMutableRenameMap to Ensuring[MutableRenameMap]

Inherited by implicit conversion ArrowAssoc fromMutableRenameMap to ArrowAssoc[MutableRenameMap]

Ungrouped