chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package annotations
  Definition Classes
    firrtl
-  package graph
  Definition Classes
    firrtl
-  package ir
  Definition Classes
    firrtl
-  package options
  Definition Classes
    firrtl
-  package passes
  Definition Classes
    firrtl
-  package renamemap
  Definition Classes
    firrtl
-  package stage

  The stage package provides Stage/Phase infrastructure for FIRRTL compilers:

  The stage package provides Stage/Phase infrastructure for FIRRTL compilers:

  - A number of support Phases
  - FirrtlOptions, a class representing options common to FIRRTL compilers
  - FirrtlOptionsView, a utility that constructs an OptionsView of FirrtlOptions from an AnnotationSeq
  Definition Classes
    firrtl
-  package transforms
  Definition Classes
    firrtl
-  package util
  Definition Classes
    firrtl
- AnnotationSeq
- BuildInfo
- CDefMPort
- CDefMemory
- EmittedAnnotation
- EmittedCircuit
- EmittedCircuitAnnotation
- EmittedComponent
- EmittedFirrtlCircuit
- EmittedFirrtlCircuitAnnotation
- EmittedVerilogCircuit
- EmittedVerilogCircuitAnnotation
- FileUtils
- FirrtlUserException
- MInfer
- MPortDir
- MRead
- MReadWrite
- MWrite
- Parser
- PrimOps
- RenameMap
- Utils

t

firrtl

# RenameMap

###
Companion object RenameMap

#### sealed trait RenameMap extends AnyRef

Map old names to new names

These are mutable datastructures for convenience

Source
  RenameMap.scala

Linear Supertypes
AnyRef, Any
Known Subclasses
MutableRenameMap
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. RenameMap
2. AnyRef
3. 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

### Abstract Value Members

1.  abstract def _chained: Option[RenameMap]
   Attributes
     protected
2.  abstract def _underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
   Attributes
     protected
3.  abstract def doDistinct: Boolean
   Attributes
     protected

### Concrete 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 RenameMap toany2stringadd[RenameMap] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ++(renameMap: RenameMap): RenameMap

   Create new RenameMap that merges this and renameMap

5.  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
     @inline()
6.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
7.  def _recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
   Attributes
     protected
8.  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

   Note

     Self renames *will* be recorded

     ,

     Rename to/tos will be made distinct

9.  def apply(t: CompleteTarget): Seq[CompleteTarget]

   Renames a CompleteTarget

   Renames a CompleteTarget

   t

     target to rename

   returns

     renamed targets

10.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
11.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
12.  def completeRename(from: CompleteTarget, tos: Seq[CompleteTarget]): Unit

    Fully rename `from` to `tos`

    Fully rename `from` to `tos`

    Attributes
      protected
13.  def ensuring(cond: (RenameMap) => Boolean, msg: => Any): RenameMap
    Implicit
      This member is added by an implicit conversion from RenameMap toEnsuring[RenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: (RenameMap) => Boolean): RenameMap
    Implicit
      This member is added by an implicit conversion from RenameMap toEnsuring[RenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean, msg: => Any): RenameMap
    Implicit
      This member is added by an implicit conversion from RenameMap toEnsuring[RenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: Boolean): RenameMap
    Implicit
      This member is added by an implicit conversion from RenameMap toEnsuring[RenameMap] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
19.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
20.  def get(key: Named): Option[Seq[Named]]
21.  def get(key: ComponentName): Option[Seq[ComponentName]]
22.  def get(key: ModuleName): Option[Seq[ModuleName]]
23.  def get(key: CircuitName): Option[Seq[CircuitName]]
24.  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

25.  def get(key: CircuitTarget): Option[Seq[CircuitTarget]]

    Get renames of a CircuitTarget

    Get renames of a CircuitTarget

    key

      Target referencing the original circuit

    returns

      Optionally return sequence of targets that key remaps to

26.  def get(key: CompleteTarget): Option[Seq[CompleteTarget]]

    Get renames of a CircuitTarget

    Get renames of a CircuitTarget

    key

      Target referencing the original circuit

    returns

      Optionally return sequence of targets that key remaps to

27.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
28.  def hasChanges: Boolean

    returns

      Whether this RenameMap has collected any changes

29.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
30.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
31.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
32.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
33.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
34.  def serialize: String

    Visualize the RenameMap

35.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
36.  def toString(): String
    Definition Classes
      AnyRef → Any
37.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
38.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
39.  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 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 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): (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.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromRenameMap to any2stringadd[RenameMap]

### Inherited by implicit conversion StringFormat fromRenameMap to StringFormat[RenameMap]

### Inherited by implicit conversion Ensuring fromRenameMap to Ensuring[RenameMap]

### Inherited by implicit conversion ArrowAssoc fromRenameMap to ArrowAssoc[RenameMap]

### Ungrouped