chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package options
  Definition Classes
    firrtl
-  package internal
  Definition Classes
    options
-  package phases
  Definition Classes
    options
- BareShell
- BufferedCustomFileEmission
- CustomFileEmission
- Dependency
- DependencyAPI
- DependencyManager
- DependencyManagerException
- DependencyManagerUtils
- DoNotTerminateOnExit
- DuplicateHandling
- ExceptOnError
- ExitCode
- ExitFailure
- ExitSuccess
- GeneralError
- HasShellOptions
- IdentityLike
- InputAnnotationFileAnnotation
- OptionsException
- OptionsHelpException
- OptionsView
- OutputAnnotationFileAnnotation
- Phase
- PhaseException
- PhaseManager
- PhasePrerequisiteException
- ProgramArgsAnnotation
- RegisteredLibrary
- Shell
- ShellOption
- Stage
- StageError
- StageMain
- StageOption
- StageOptions
- StageOptionsView
- StageUtils
- TargetDirAnnotation
- TransformLike
- Translator
- Unserializable
- Viewer

t

firrtl.options

# DependencyManager

###

#### trait DependencyManager[A, B <: TransformLike[A] with DependencyAPI[B]] extends TransformLike[A] with DependencyAPI[B]

A TransformLike that resolves a linear ordering of dependencies based on requirements.

A

  the type over which this transforms

B

  the type of the TransformLike

Source
  DependencyManager.scala

Linear Supertypes
DependencyAPI[B], TransformLike[A], LazyLogging, AnyRef, Any
Known Subclasses
PhaseManager
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. DependencyManager
2. DependencyAPI
3. TransformLike
4. LazyLogging
5. AnyRef
6. 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 copy(targets: Seq[Dependency[B]], currentState: Seq[Dependency[B]], knownObjects: Set[B] = dependencyToObject.values.toSet): B

   A method that will create a copy of this DependencyManager, but with different requirements.

   A method that will create a copy of this DependencyManager, but with different requirements. This is used to solve sub-problems arising from invalidations.

   Attributes
     protected
2.  abstract def currentState: Seq[Dependency[B]]

   A sequence of TransformLikes that have been run.

   A sequence of TransformLikes that have been run. Internally, this will be converted to an ordered set.

3.  abstract def knownObjects: Set[B]

   Existing transform objects that have already been constructed

4.  abstract def name: String

   An identifier of this TransformLike that can be used for logging and informational printing

   An identifier of this TransformLike that can be used for logging and informational printing

   Definition Classes
     TransformLike
5.  abstract def targets: Seq[Dependency[B]]

   Requested TransformLikes that should be run.

   Requested TransformLikes that should be run. Internally, this will be converted to a set based on the ordering defined here.

### 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 DependencyManager[A, B] toany2stringadd[DependencyManager[A, B]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (DependencyManager[A, B], B)
   Implicit
     This member is added by an implicit conversion from DependencyManager[A, B] toArrowAssoc[DependencyManager[A, B]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  val colormap: Seq[String]

   This colormap uses Colorbrewer's 4-class OrRd color scheme

   This colormap uses Colorbrewer's 4-class OrRd color scheme

   Attributes
     protected
9.  def customPrintHandling(tab: String, charSet: CharSet, size: Int): Option[PartialFunction[(B, Int), Seq[String]]]

   A method that can be overridden to define custom print handling.

   A method that can be overridden to define custom print handling. This is useful if you would like to make some transform print additional information.

   tab

     the current tab setting

   charSet

     the character set in use

   size

     the number of nodes at the current level of the tree

10.  def dependenciesToGraphviz: String

    Convert all prerequisites, optionalPrerequisites, optionalPrerequisiteOf, and invalidates to a Graphviz representation.

11.  lazy val dependencyGraph: DiGraph[B]

    A directed graph consisting of all prerequisites, including prerequisites derived from optionalPrerequisites and optionalPrerequisiteOf

12.  lazy val dependencyToObject: LinkedHashMap[Dependency[B], B]

    Store of conversions between classes and objects.

    Store of conversions between classes and objects. Objects that do not exist in the map will be lazily constructed.

    Attributes
      protected
13.  def ensuring(cond: (DependencyManager[A, B]) => Boolean, msg: => Any): DependencyManager[A, B]
    Implicit
      This member is added by an implicit conversion from DependencyManager[A, B] toEnsuring[DependencyManager[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: (DependencyManager[A, B]) => Boolean): DependencyManager[A, B]
    Implicit
      This member is added by an implicit conversion from DependencyManager[A, B] toEnsuring[DependencyManager[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean, msg: => Any): DependencyManager[A, B]
    Implicit
      This member is added by an implicit conversion from DependencyManager[A, B] toEnsuring[DependencyManager[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: Boolean): DependencyManager[A, B]
    Implicit
      This member is added by an implicit conversion from DependencyManager[A, B] toEnsuring[DependencyManager[A, B]] 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.  lazy val flattenedTransformOrder: Seq[B]

    A version of the transformOrder that flattens the transforms of any internal DependencyManagers.

21.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  def getLogger: Logger
    Definition Classes
      LazyLogging
23.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
24.  lazy val invalidateGraph: DiGraph[B]

    A directed graph consisting of invalidation edges

25.  def invalidates(a: B): Boolean

    A function that, given *another* transform (parameter `a`) will return true if this transform invalidates/undos the effects of the *other* transform (parameter `a`).

    A function that, given *another* transform (parameter `a`) will return true if this transform invalidates/undos the effects of the *other* transform (parameter `a`).

    a

      transform

    Definition Classes
      DependencyManager → DependencyAPI
26.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
27.  val logger: Logger
    Attributes
      protected
    Definition Classes
      LazyLogging
28.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
29.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
30.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
31.  def optionalPrerequisiteOf: Seq[Dependency[B]]

    A sequence of transforms to add this transform as an `optionalPrerequisite`.

    A sequence of transforms to add this transform as an `optionalPrerequisite`. The use of `optionalPrerequisiteOf` enables the transform declaring them to always run before some other transforms. However, declaring `optionalPrerequisiteOf` will not result in the sequence of transforms executing.

    This is useful for providing an ordering constraint to guarantee that other transforms (e.g., emitters) will not be scheduled before you.

    Definition Classes
      DependencyManager → DependencyAPI
    Note

      This method **will not** result in the listed transforms running. If you want to add multiple transforms at once, you should use a `DependencyManager` with multiple targets.

32.  def optionalPrerequisites: Seq[Dependency[B]]

    All transforms that, if a prerequisite of *another* transform, will run before this transform.

    All transforms that, if a prerequisite of *another* transform, will run before this transform.

    Definition Classes
      DependencyManager → DependencyAPI
    Note

      The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

33.  def prerequisites: Seq[Dependency[B]]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
      DependencyManager → DependencyAPI
    Note

      The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

34.  def prettyPrint(tab: String = "", charSet: CharSet = DependencyManagerUtils.PrettyCharSet): String

    Textually show the determined transform order

    Textually show the determined transform order

    tab

      an indentation string to use for every line of output

    charSet

      a collection of characters to use when printing

35.  def prettyPrintRec(tab: String, charSet: CharSet): Seq[String]

    Helper utility when recursing during pretty printing

    Helper utility when recursing during pretty printing

    tab

      an indentation string to use for every line of output

    charSet

      a collection of characters to use when printing

36.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
37.  def toString(): String
    Definition Classes
      AnyRef → Any
38.  final def transform(annotations: A): A

    A mathematical transform on some type

    A mathematical transform on some type

    returns

      an output object of the same type

    Definition Classes
      DependencyManager → TransformLike
39.  lazy val transformOrder: Seq[B]

    An ordering of TransformLikes that causes the requested targets to be executed starting from the currentState.

    An ordering of TransformLikes that causes the requested targets to be executed starting from the currentState. This ordering respects prerequisites, optionalPrerequisites, optionalPrerequisiteOf, and invalidates of all constituent TransformLikes. This uses an algorithm that attempts to reduce the number of re-lowerings due to invalidations. Re-lowerings are implemented as new firrtl.options.DependencyManagers.

    Exceptions thrown

      `firrtl.options.DependencyManagerException` if a cycle exists in either the dependencyGraph or the invalidateGraph.

40.  def transformOrderToGraphviz(colormap: Seq[String] = colormap): String
41.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
42.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
43.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
44.  def wrappers: Seq[(B) => B]

    A sequence of wrappers to apply to the resulting TransformLike sequence.

    A sequence of wrappers to apply to the resulting TransformLike sequence. This can be used to, e.g., add automated pre-processing and post-processing.

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from DependencyManager[A, B] toStringFormat[DependencyManager[A, B]] 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): (DependencyManager[A, B], B)
   Implicit
     This member is added by an implicit conversion from DependencyManager[A, B] toArrowAssoc[DependencyManager[A, B]] 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 DependencyAPI[B]

### Inherited from TransformLike[A]

### Inherited from LazyLogging

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromDependencyManager[A, B] to any2stringadd[DependencyManager[A, B]]

### Inherited by implicit conversion StringFormat fromDependencyManager[A, B] to StringFormat[DependencyManager[A, B]]

### Inherited by implicit conversion Ensuring fromDependencyManager[A, B] to Ensuring[DependencyManager[A, B]]

### Inherited by implicit conversion ArrowAssoc fromDependencyManager[A, B] to ArrowAssoc[DependencyManager[A, B]]

### Ungrouped