Class/Object

Chisel

Node

Related Docs: object Node | package Chisel

Permalink

abstract class Node extends Nameable

*Node* defines the root class of the class hierarchy for a [Composite Pattern](http://en.wikipedia.org/wiki/Composite_pattern).

A digital logic graph is encoded as adjacency graph where instances of *Node* describe vertices and *inputs*, *consumers* member fields are used to traverse the directed graph respectively backward (from output to input) and forward (from input to output).

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

Instance Constructors

  1. new Node()

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. 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

  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def <>(src: Node): Unit

    Permalink
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. 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

  7. def ^^(src: Node): Unit

    Permalink
  8. val _id: Int

    Permalink

    The unique id of this node

  9. def _isComplementOf(x: Node): Boolean

    Permalink
  10. final def asInstanceOf[T0]: T0

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

    Permalink
  12. final def asUInt(): UInt

    Permalink
  13. def assign(src: Node): Unit

    Permalink
  14. def canCSE: Boolean

    Permalink
  15. lazy val chiselName: String

    Permalink
  16. var clock: Option[Clock]

    Permalink

    The clock for this node

  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. 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

  19. val consumers: LinkedHashSet[Node]

    Permalink

    nodes that consume one of my outputs

  20. def dblLitValue: Double

    Permalink

    Convert the node literal to a Double

  21. var driveRand: Boolean

    Permalink
  22. final def eq(arg0: AnyRef): Boolean

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

    Permalink

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

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

    Permalink
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def floLitValue: Float

    Permalink

    Convert the node literal to a Float

  27. final def getClass(): Class[_]

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

    Permalink

    returns

    The root node input

  29. def getWidth(): Int

    Permalink

    returns

    the width or number of bits used by this node

    Exceptions thrown

    ChiselException if the width of the node is unknown

  30. def hashCode(): Int

    Permalink

    returns

    the unique hashCode for this node

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

    Permalink
  32. 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.

  33. 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

  34. 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

  35. 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

  36. val inputs: ArrayBuffer[Node]

    Permalink

    The inputs that this node depends on

  37. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  38. def isIo: Boolean

    Permalink

    returns

    this node is an I/O Node for a module

  39. def isIo_=(isIo: Boolean): Unit

    Permalink
    Attributes
    protected[Chisel]
  40. final def isLit: Boolean

    Permalink

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

  41. def isTopLevelIO: Boolean

    Permalink

    returns

    is this node I/O for the top level module

  42. var isTypeNode: Boolean

    Permalink
  43. 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.

    Attributes
    protected[Chisel]
  44. def isUsedByClockHi: Boolean

    Permalink

    returns

    this node is a Register

  45. def isZeroWidth: Boolean

    Permalink

    returns

    this node has zero-width

  46. val line: StackTraceElement

    Permalink

    The trace information for chisel for this node

  47. def litOf: Literal

    Permalink

    returns

    the literal value of a node

    Exceptions thrown

    ChiselException if there is no literal value available

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

    Permalink

    returns

    the literal value of the node as a BigInt

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

    Permalink

    Deprecated: Do not use

  50. var modified: Boolean

    Permalink
  51. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  52. 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
  53. final def ne(arg0: AnyRef): Boolean

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

    Permalink

    returns

    the bitWidth of the node

    Exceptions thrown

    ChiselException if the width is not yet defined

  55. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  57. 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

  58. var prune: Boolean

    Permalink
  59. 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

  60. def review(): Unit

    Permalink

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

  61. 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")
  62. 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

  63. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink

    returns

    This node as a UInt

  65. def toNode: Node

    Permalink

    returns

    This node

  66. def toSInt(): SInt

    Permalink
  67. def toString(): String

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

    Permalink
  69. def usesInClockHi(i: Node): Boolean

    Permalink
  70. final def wait(): Unit

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

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

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

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped