Class

Chisel

Aggregate

Related Doc: package Chisel

Permalink

abstract class Aggregate extends Data

Source
Aggregate.scala
Linear Supertypes
Data, Node, Nameable, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aggregate
  2. Data
  3. Node
  4. Nameable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Aggregate()

    Permalink

Abstract Value Members

  1. abstract def asDirectionless(): Aggregate.this.type

    Permalink

    set this node as directionless

    set this node as directionless

    Definition Classes
    Data
  2. abstract def asOutput(): Aggregate.this.type

    Permalink

    Sets the direction (*dir*) of instances derived from Bits to OUTPUT or recursively sets members of Bundle/Vec to OUTPUT.

    Sets the direction (*dir*) of instances derived from Bits to OUTPUT or recursively sets members of Bundle/Vec to OUTPUT.

    returns

    this instance with its exact type.

    Definition Classes
    Data
  3. abstract def flatten: Array[(String, Bits)]

    Permalink
    Definition Classes
    Data

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##[T <: Data](right: T): Aggregate.this.type

    Permalink

    Interface required by Cat is an operator to combine data nodes together

    Interface required by Cat is an operator to combine data nodes together

    Definition Classes
    Data
  3. def ##(b: Node): Node

    Permalink

    The cat operator to combine two values

    The cat operator to combine two values

    0x5 ## 0x3 => 0x53
    b

    Node to cat after

    returns

    a new node as the combination of both this node and b

    Definition Classes
    Node
  4. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  5. def :=(that: Data): Unit

    Permalink
    Definition Classes
    Data
  6. def <>(src: Node): Unit

    Permalink
    Definition Classes
    Node
  7. def =/=[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    Data
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def ===[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    Data
  10. def W0Wtransform(): Unit

    Permalink

    Eliminate any zero-width wires attached to this node

    Eliminate any zero-width wires attached to this node

    returns

    if the node was modified

    Definition Classes
    Node
  11. def ^^(src: Node): Unit

    Permalink
    Definition Classes
    Node
  12. val _id: Int

    Permalink

    The unique id of this node

    The unique id of this node

    Definition Classes
    Node
  13. def _isComplementOf(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  14. def apply(name: String): Data

    Permalink
    Definition Classes
    Data
  15. def asInput(): Aggregate.this.type

    Permalink

    Return this object as an INPUT

    Return this object as an INPUT

    Definition Classes
    Data
  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. final def asSInt(): SInt

    Permalink
    Definition Classes
    Node
  18. final def asUInt(): UInt

    Permalink
    Definition Classes
    Node
  19. def assign(src: Node): Unit

    Permalink
    Definition Classes
    Node
  20. def canCSE: Boolean

    Permalink
    Definition Classes
    Node
  21. lazy val chiselName: String

    Permalink
    Definition Classes
    Node
  22. var clock: Option[Clock]

    Permalink

    The clock for this node

    The clock for this node

    Definition Classes
    Node
  23. def clone(): Aggregate.this.type

    Permalink
    Definition Classes
    Data → AnyRef
  24. def cloneType(): Aggregate.this.type

    Permalink
    Definition Classes
    Data
  25. def colonEquals[T <: Data](that: Seq[T]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  26. def colonEquals(that: Bundle): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  27. def colonEquals(that: Bits): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  28. var comp: Option[proc]

    Permalink
    Definition Classes
    Data
  29. def componentOf: Module

    Permalink

    Get the module that this node is a part of or the top module if not assigned yet

    Get the module that this node is a part of or the top module if not assigned yet

    returns

    The module that this node is a part of

    Definition Classes
    Node
  30. val consumers: LinkedHashSet[Node]

    Permalink

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes
    Node
  31. def dblLitValue: Double

    Permalink

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  32. var driveRand: Boolean

    Permalink
    Definition Classes
    Node
  33. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. def equals(that: Any): Boolean

    Permalink

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

    Definition Classes
    Node → AnyRef → Any
  35. def equalsForCSE(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  36. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def flip(): Aggregate.this.type

    Permalink

    Change INPUTs to OUTPUTs and visa versa

    Change INPUTs to OUTPUTs and visa versa

    Definition Classes
    Data
  38. def floLitValue: Float

    Permalink

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  39. def fromBits(b: Bits): Aggregate.this.type

    Permalink
    Definition Classes
    Data
  40. def fromNode(n: Node): Aggregate.this.type

    Permalink

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Definition Classes
    Data
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. def getNode: Node

    Permalink

    returns

    The root node input

    Definition Classes
    Node
  43. def getWidth(): Int

    Permalink

    returns

    the width or number of bits used by this node

    Definition Classes
    AggregateNode
    Exceptions thrown

    ChiselException if the width of the node is unknown

  44. def hashCode(): Int

    Permalink

    returns

    the unique hashCode for this node

    Definition Classes
    Node → AnyRef → Any
  45. def hashCodeForCSE: Int

    Permalink
    Definition Classes
    Node
  46. def illegalAssignment(that: Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  47. def infer: Boolean

    Permalink

    Called while we're walking the graph inferring the width of nodes.

    Called while we're walking the graph inferring the width of nodes. We return true if we should continue to walk the graph, either because there's a node whose width we don't know, or because we updated a node's width.

    Definition Classes
    Node
  48. def init(n: String, w: Int, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    w

    the bit width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  49. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthFunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  50. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Seq[Node]): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthfunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  51. val inputs: ArrayBuffer[Node]

    Permalink

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  52. def isDirectionless: Boolean

    Permalink

    check if this node is neither INPUT or OUTPUT

    check if this node is neither INPUT or OUTPUT

    Definition Classes
    Data
  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  54. def isIo: Boolean

    Permalink

    returns

    this node is an I/O Node for a module

    Definition Classes
    Node
  55. def isIo_=(isIo: Boolean): Unit

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    Node
  56. final def isLit: Boolean

    Permalink

    This function determines if a node is a literal, a fixed value

    This function determines if a node is a literal, a fixed value

    Definition Classes
    Node
  57. def isTopLevelIO: Boolean

    Permalink

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  58. var isTypeNode: Boolean

    Permalink
    Definition Classes
    Node
  59. def isTypeOnly: Boolean

    Permalink

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Definition Classes
    DataNode
  60. def isUsedByClockHi: Boolean

    Permalink

    returns

    this node is a Register

    Definition Classes
    Node
  61. def isWired: Boolean

    Permalink
    Definition Classes
    AggregateData
  62. def isZeroWidth: Boolean

    Permalink

    returns

    this node has zero-width

    Definition Classes
    Node
  63. val line: StackTraceElement

    Permalink

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  64. def litOf: Literal

    Permalink

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if there is no literal value available

  65. def litValue(default: BigInt = BigInt(-1)): BigInt

    Permalink

    returns

    the literal value of the node as a BigInt

    Bool(true).litValue() => BigInt(1)
    Definition Classes
    Node
  66. def maybeFlatten: Seq[Node]

    Permalink

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  67. var modified: Boolean

    Permalink
    Definition Classes
    Node
  68. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  69. def nameIt(path: String, isNamingIo: Boolean): Unit

    Permalink

    name this node

    name this node

    Definition Classes
    DataNode
    Note

    use setName in Node rather than this directly

  70. var named: Boolean

    Permalink

    named is used to indicate that name was set explicitly and should not be overriden

    named is used to indicate that name was set explicitly and should not be overriden

    Definition Classes
    Nameable
  71. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  72. def needWidth(): Int

    Permalink

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width is not yet defined

  73. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  74. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  75. def params: Parameters

    Permalink
    Definition Classes
    Data
  76. def printTree(writer: PrintStream, depth: Int = 4, indent: String = ""): Unit

    Permalink

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Definition Classes
    Node
  77. var prune: Boolean

    Permalink
    Definition Classes
    Node
  78. def replaceTree(newNode: Node): Unit

    Permalink

    Replace the subtree starting from this node with the indicated replacement

    Replace the subtree starting from this node with the indicated replacement

    newNode

    The node to start tree from

    Definition Classes
    Node
  79. def review(): Unit

    Permalink

    Review a node for optimization possibilities if its children have been updated

    Review a node for optimization possibilities if its children have been updated

    Definition Classes
    Node
  80. def setIsTypeNode: Unit

    Permalink

    make this node a type node

    make this node a type node

    Definition Classes
    Data
  81. def setIsWired(value: Boolean): Unit

    Permalink
    Definition Classes
    AggregateData
  82. def setName(n: String): Unit

    Permalink

    Set the name of this module to the string 'n'

    Set the name of this module to the string 'n'

    Definition Classes
    Nameable
    Example:
    1. my.io.node.setName("MY_IO_NODE")
  83. def setWidth(w: Int): Unit

    Permalink

    Force the bit width of a node

    Force the bit width of a node

    w

    the bit width to force

    Definition Classes
    Node
  84. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  85. def toBits(): UInt

    Permalink

    returns

    This node as a UInt

    Definition Classes
    Node
  86. def toBool(): Bool

    Permalink

    Try to convert this data to a Bool

    Try to convert this data to a Bool

    Definition Classes
    Data
    Exceptions thrown

    ChiselException if the width is not 1

  87. lazy val toNode: Node

    Permalink

    returns

    This node

    Definition Classes
    DataNode
  88. def toSInt(): SInt

    Permalink
    Definition Classes
    Node
  89. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  90. def toUInt(): UInt

    Permalink
    Definition Classes
    Node
  91. def usesInClockHi(i: Node): Boolean

    Permalink
    Definition Classes
    Node
  92. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Data

Inherited from Node

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped