Class/Object

Chisel

Complex

Related Docs: object Complex | package Chisel

Permalink

class Complex[T <: Data with Num[T]] extends Bundle with Num[Complex[T]]

Complex number representation create using the object Complex

Source
Complex.scala
Example:
  1. val myNum = Complex[Fixed](Fixed(3, 16, 8), Fixed(1, 16, 8))
Linear Supertypes
Num[Complex[T]], Bundle, Aggregate, Data, Node, Nameable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Complex
  2. Num
  3. Bundle
  4. Aggregate
  5. Data
  6. Node
  7. Nameable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Complex(real: T, imag: T)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##[T <: Data](right: T): Complex.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 %(r: Complex[T]): Complex[T]

    Permalink

    Uses the % operator defined in the types Is defined as:

    Uses the % operator defined in the types Is defined as:

    (this.real % r.real) + (this.imag % r.imag)i
    Definition Classes
    ComplexNum
  6. def *(r: T): Complex[T]

    Permalink
  7. def *(r: Complex[T]): Complex[T]

    Permalink

    A complex multiply, uses 3 multiplies by default Change to use four with the use_four_mults boolean variable

    A complex multiply, uses 3 multiplies by default Change to use four with the use_four_mults boolean variable

    Definition Classes
    ComplexNum
  8. def +(r: Complex[T]): Complex[T]

    Permalink

    Add a scalar value to both the real and imaginary parts

    Add a scalar value to both the real and imaginary parts

    Definition Classes
    ComplexNum
  9. def +(other: Bundle): Bundle

    Permalink

    Create a new Bundle with all the elements of both

    Create a new Bundle with all the elements of both

    Definition Classes
    Bundle
  10. def -(r: Complex[T]): Complex[T]

    Permalink

    Subtract a scalar value from both the real and imaginary parts

    Subtract a scalar value from both the real and imaginary parts

    Definition Classes
    ComplexNum
  11. def /(r: T): Complex[T]

    Permalink
  12. def /(r: Complex[T]): Complex[T]

    Permalink
    Definition Classes
    ComplexNum
  13. def :=(that: Data): Unit

    Permalink
    Definition Classes
    Data
  14. def <(b: Complex[T]): Bool

    Permalink

    Compare the magnitudes of the complex numbers

    Compare the magnitudes of the complex numbers

    Definition Classes
    ComplexNum
  15. def <=(b: Complex[T]): Bool

    Permalink

    Compare the magnitudes of the complex numbers

    Compare the magnitudes of the complex numbers

    Definition Classes
    ComplexNum
  16. def <>(src: Node): Unit

    Permalink

    Connect all elements contained in this to node 'src'

    Connect all elements contained in this to node 'src'

    Definition Classes
    BundleNode
    Example:
    1.  // pass through all wires in this modules io to the sub module which have the same name
      // Note: ignores any extra defined in io
      mySubModule.io <> io
    Note

    The elements are checked for compatibility based on their name If elements are in src that are not in this Bundle no warning will be produced

  17. def =/=[T <: Data](right: T): Bool

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

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

    Permalink
    Definition Classes
    Data
  20. def >(b: Complex[T]): Bool

    Permalink

    Compare the magnitudes of the complex numbers

    Compare the magnitudes of the complex numbers

    Definition Classes
    ComplexNum
  21. def >=(b: Complex[T]): Bool

    Permalink

    Compare the magnitudes of the complex numbers

    Compare the magnitudes of the complex numbers

    Definition Classes
    ComplexNum
  22. 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
  23. def ^^(src: Node): Unit

    Permalink
    Definition Classes
    Node
  24. val _id: Int

    Permalink

    The unique id of this node

    The unique id of this node

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

    Permalink
    Definition Classes
    Node
  26. def abs2: T

    Permalink

    Compute the magnitude of the complex number: real2 + imag2

  27. def apply(name: String): Data

    Permalink
    Definition Classes
    BundleData
  28. def asDirectionless(): Complex.this.type

    Permalink

    set this node as directionless

    set this node as directionless

    Definition Classes
    BundleData
  29. def asInput(): Complex.this.type

    Permalink

    Return this object as an INPUT

    Return this object as an INPUT

    Definition Classes
    BundleData
  30. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  31. def asOutput(): Complex.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
    BundleData
  32. final def asSInt(): SInt

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

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

    Permalink
    Definition Classes
    Node
  35. def calcElements(view: Seq[String]): LinkedHashMap[String, Data]

    Permalink

    Populates the cache of elements declared in the Bundle.

    Populates the cache of elements declared in the Bundle.

    Attributes
    protected
    Definition Classes
    Bundle
  36. def canCSE: Boolean

    Permalink
    Definition Classes
    Node
  37. def checkPort(obj: Any, name: String): Boolean

    Permalink

    Check that 'name' is a valid component of Complex, ie) real or imag

    Check that 'name' is a valid component of Complex, ie) real or imag

    Attributes
    protected
    Definition Classes
    ComplexBundle
  38. lazy val chiselName: String

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

    Permalink

    The clock for this node

    The clock for this node

    Definition Classes
    Node
  40. def clone(): Complex.this.type

    Permalink
    Definition Classes
    Data → AnyRef
  41. def cloneType(): Complex.this.type

    Permalink

    Clone a complex instantiation

    Clone a complex instantiation

    Definition Classes
    ComplexData
  42. def colonEquals(src: Bundle): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BundleData
  43. def colonEquals[T <: Data](that: Seq[T]): Unit

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

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

    Permalink
    Definition Classes
    Data
  46. 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
  47. def conj: Complex[T]

    Permalink

    Create a new complex number which is the conjugate of this one

  48. val consumers: LinkedHashSet[Node]

    Permalink

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes
    Node
  49. def contains(name: String): Boolean

    Permalink

    Check if an element exists with that name

    Check if an element exists with that name

    Definition Classes
    Bundle
  50. def dblLitValue: Double

    Permalink

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  51. var driveRand: Boolean

    Permalink
    Definition Classes
    Node
  52. lazy val elements: LinkedHashMap[String, Data]

    Permalink
    Definition Classes
    Bundle
  53. final def eq(arg0: AnyRef): Boolean

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

    Permalink

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  57. def flatten: Array[(String, Bits)]

    Permalink
    Definition Classes
    BundleData
  58. def flip(): Complex.this.type

    Permalink

    Change all INPUT to OUTPUT and visa versa for all elements in this Bundle

    Change all INPUT to OUTPUT and visa versa for all elements in this Bundle

    Definition Classes
    BundleData
  59. def floLitValue: Float

    Permalink

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  60. def fromBits(b: Bits): Complex.this.type

    Permalink
    Definition Classes
    Data
  61. def fromMap(elemmap: Map[String, Data]): Complex.this.type

    Permalink

    Connect all data nodes in the map as inputs for this bundle using the names in the map

    Connect all data nodes in the map as inputs for this bundle using the names in the map

    Definition Classes
    Bundle
  62. def fromNode(n: Node): Complex.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
  63. final def getClass(): Class[_]

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

    Permalink

    returns

    The root node input

    Definition Classes
    Node
  65. def getWidth(): Int

    Permalink

    returns

    the width or number of bits used by this node

    Definition Classes
    BundleAggregateNode
    Exceptions thrown

    ChiselException if the width of the node is unknown

  66. def hashCode(): Int

    Permalink

    returns

    the unique hashCode for this node

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  69. val imag: T

    Permalink
  70. 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
  71. 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
  72. 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
  73. 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
  74. val inputs: ArrayBuffer[Node]

    Permalink

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  75. def isDirectionless: Boolean

    Permalink

    check if this node is neither INPUT or OUTPUT

    check if this node is neither INPUT or OUTPUT

    Definition Classes
    BundleData
  76. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  77. def isIo: Boolean

    Permalink

    returns

    this node is an I/O Node for a module

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

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    Node
  79. 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
  80. def isTopLevelIO: Boolean

    Permalink

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  81. var isTypeNode: Boolean

    Permalink
    Definition Classes
    Node
  82. 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
    BundleDataNode
  83. def isUsedByClockHi: Boolean

    Permalink

    returns

    this node is a Register

    Definition Classes
    Node
  84. def isWired: Boolean

    Permalink
    Definition Classes
    AggregateData
  85. def isZeroWidth: Boolean

    Permalink

    returns

    this node has zero-width

    Definition Classes
    Node
  86. val line: StackTraceElement

    Permalink

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  87. def litOf: Literal

    Permalink

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if there is no literal value available

  88. 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
  89. def max(b: Complex[T]): Complex[T]

    Permalink
    Definition Classes
    Num
  90. def maybeFlatten: Seq[Node]

    Permalink

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  91. def min(b: Complex[T]): Complex[T]

    Permalink
    Definition Classes
    Num
  92. var modified: Boolean

    Permalink
    Definition Classes
    Node
  93. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

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

    Permalink

    Name the bundle, do not use directly, use setName instead

    Name the bundle, do not use directly, use setName instead

    Definition Classes
    BundleDataNode
  95. 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
  96. final def ne(arg0: AnyRef): Boolean

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

    Permalink

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width is not yet defined

  98. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  100. def params: Parameters

    Permalink
    Definition Classes
    Data
  101. 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
  102. var prune: Boolean

    Permalink
    Definition Classes
    Node
  103. val real: T

    Permalink
  104. def removeTypeNodes(): Unit

    Permalink
    Definition Classes
    BundleNode
  105. 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
  106. 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
  107. def setIsTypeNode: Unit

    Permalink

    make this node a type node

    make this node a type node

    Definition Classes
    BundleData
  108. def setIsWired(value: Boolean): Unit

    Permalink
    Definition Classes
    AggregateData
  109. 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")
  110. 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
  111. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink

    returns

    This node as a UInt

    Definition Classes
    Node
  113. 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

  114. lazy val toNode: Node

    Permalink

    returns

    This node

    Definition Classes
    DataNode
  115. def toSInt(): SInt

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

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

    Permalink
    Definition Classes
    Node
  118. def unary_-(): Complex[T]

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

    Permalink
    Definition Classes
    Node
  120. val view: Seq[String]

    Permalink
    Definition Classes
    Bundle
  121. final def wait(): Unit

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

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

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

Inherited from Num[Complex[T]]

Inherited from Bundle

Inherited from Aggregate

Inherited from Data

Inherited from Node

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped