Chisel

SInt

class SInt extends Bits with Num[SInt]

Source
SInt.scala
Linear Supertypes
Num[SInt], Bits, proc, Data, Node, Nameable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SInt
  2. Num
  3. Bits
  4. proc
  5. Data
  6. Node
  7. Nameable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SInt()

Type Members

  1. type T = SInt

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. def ##[T <: Data](right: T): SInt.this.type

    Cat bits together to into a single data object with the width of both combined

    Cat bits together to into a single data object with the width of both combined

    Definition Classes
    BitsData
  4. def ##(b: Node): Node

    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
  5. final def ##(): Int

    Definition Classes
    AnyRef → Any
  6. def %(b: UInt): SInt

  7. def %(b: SInt): SInt

    Definition Classes
    SIntNum
  8. def %(b: Bits): Bits

    Definition Classes
    Bits
  9. def &(b: Bits): SInt.this.type

    Bitwise and

    Bitwise and

    Definition Classes
    Bits
  10. def *(b: UInt): SInt

  11. def *(b: SInt): SInt

    Definition Classes
    SIntNum
  12. def *(b: Bits): Bits

    Definition Classes
    Bits
  13. def +(b: UInt): SInt

  14. def +(b: SInt): SInt

    Definition Classes
    SIntNum
  15. def +(b: Bits): Bits

    Definition Classes
    Bits
  16. def +%(b: SInt): SInt

    chisel3 add-wrap operator

  17. def +&(b: SInt): SInt

    chisel3 add (width + 1) operator

  18. def -(b: UInt): SInt

  19. def -(b: SInt): SInt

    Definition Classes
    SIntNum
  20. def -(b: Bits): Bits

    Definition Classes
    Bits
  21. def -%(b: SInt): SInt

    chisel3 sub-wrap operator

  22. def -&(b: SInt): SInt

    chisel3 sub (width + 1) operator

  23. def /(b: UInt): SInt

  24. def /(b: SInt): SInt

    Definition Classes
    SIntNum
  25. def /(b: Bits): Bits

    Definition Classes
    Bits
  26. def :=(that: Data): Unit

    Definition Classes
    Data
  27. def <(b: UInt): Bool

  28. def <(b: SInt): Bool

    Definition Classes
    SIntNum
  29. def <<(i: Int): SInt

  30. def <<(b: UInt): SInt.this.type

    Shift left operation

    Shift left operation

    Definition Classes
    Bits
  31. def <=(b: UInt): Bool

  32. def <=(b: SInt): Bool

    Definition Classes
    SIntNum
  33. def <>(src: Node): Unit

    Connect I/O of modules with the same name

    Connect I/O of modules with the same name

    src

    Node to attempt to connect to this instantiation

    Definition Classes
    BitsNode
  34. def =/=(b: UInt): Bool

  35. def =/=(that: BitPat): Bool

    Definition Classes
    Bits
  36. def =/=(b: Bits): Bool

    not equal to

    not equal to

    Definition Classes
    Bits
  37. def =/=[T <: Data](right: T): Bool

    Definition Classes
    Data
  38. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  39. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  40. def ===[T <: Data](right: T): Bool

    Definition Classes
    SIntBitsData
  41. def ===(that: BitPat): Bool

    Definition Classes
    Bits
  42. def >(b: UInt): Bool

  43. def >(b: SInt): Bool

    Definition Classes
    SIntNum
  44. def >=(b: UInt): Bool

  45. def >=(b: SInt): Bool

    Definition Classes
    SIntNum
  46. def >>(i: Int): SInt

  47. def >>(b: UInt): SInt

  48. def ?(b: SInt): SInt

  49. def W0Wtransform(): Unit

    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
  50. def ^(b: Bits): SInt.this.type

    Bitwise xor

    Bitwise xor

    Definition Classes
    Bits
  51. def ^^(src: Node): Unit

    Definition Classes
    Node
  52. val _id: Int

    The unique id of this node

    The unique id of this node

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

    Definition Classes
    Node
  54. def abs: UInt

  55. def andR(): Bool

    reduction and, and all bits together

    reduction and, and all bits together

    Definition Classes
    Bits
  56. final def apply(range: (Int, Int)): UInt

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    Definition Classes
    Bits
  57. final def apply(hi: UInt, lo: UInt): UInt

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    Definition Classes
    Bits
  58. final def apply(hi: Int, lo: Int): UInt

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    myBits = 0x5, myBits(1,0) => 0x3
    Definition Classes
    Bits
  59. final def apply(bit: UInt): Bool

    Extract a single bit at position 'bit' as a Bool

    Extract a single bit at position 'bit' as a Bool

    Definition Classes
    Bits
  60. final def apply(bit: Int): Bool

    Extract a single Bool at index *bit*.

    Extract a single Bool at index *bit*.

    Definition Classes
    Bits
  61. def apply(name: String): Data

    Definition Classes
    BitsData
  62. def asDirectionless(): SInt.this.type

    Set this Bits instantiation to be neither of INPUT or OUTPUT

    Set this Bits instantiation to be neither of INPUT or OUTPUT

    Definition Classes
    BitsData
  63. def asInput(): SInt.this.type

    Set this Bits instatiation to be an INPUT

    Set this Bits instatiation to be an INPUT

    Definition Classes
    BitsData
  64. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  65. def asOutput(): SInt.this.type

    Set this Bits instatiation to be an OUTPUT

    Set this Bits instatiation to be an OUTPUT

    returns

    this instance with its exact type.

    Definition Classes
    BitsData
  66. final def asSInt(): SInt

    Definition Classes
    Bits
  67. final def asTypeFor(node: Node): SInt.this.type

    assigns this instance as the data type for *node*.

    assigns this instance as the data type for *node*.

    Attributes
    protected[Chisel]
    Definition Classes
    Bits
  68. final def asUInt(): UInt

    Definition Classes
    Bits
  69. def assign(src: Node): Unit

    Definition Classes
    BitsNode
  70. def bitSet(off: UInt, dat: UInt): SInt.this.type

    Set bit 'off' in data dat

    Set bit 'off' in data dat

    off

    which bit to set

    dat

    A UInt in which to set the bit

    Definition Classes
    Bits
  71. def canCSE: Boolean

    Definition Classes
    Node
  72. lazy val chiselName: String

    Definition Classes
    Node
  73. var clock: Option[Clock]

    The clock for this node

    The clock for this node

    Definition Classes
    Node
  74. def clone(): SInt.this.type

    Definition Classes
    Data → AnyRef
  75. def cloneType(): SInt.this.type

    Copy this instantiation of the Chisel Data type with all parameters such as width and I/O direction the same

    Copy this instantiation of the Chisel Data type with all parameters such as width and I/O direction the same

    Definition Classes
    BitsData
  76. def colonEquals(that: Bits): Unit

    casting from UInt followed by assignment.

    casting from UInt followed by assignment.

    Attributes
    protected
    Definition Classes
    SIntBitsData
  77. def colonEquals[T <: Data](that: Seq[T]): Unit

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

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

    Definition Classes
    Data
  80. def componentOf: Module

    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
  81. val consumers: LinkedHashSet[Node]

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes
    Node
  82. def create(dir: IODirection, width: Int): Unit

    Definition Classes
    Bits
  83. def dblLitValue: Double

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  84. def default: proc

    Attributes
    protected
    Definition Classes
    proc
  85. def defaultMissing: Boolean

    Attributes
    protected
    Definition Classes
    proc
  86. def defaultRequired: Boolean

    Definition Classes
    Bitsproc
  87. var dir: IODirection

    Definition Classes
    Bits
  88. def doProcAssign(src: Node, cond: Bool): Unit

    Attributes
    protected[Chisel]
    Definition Classes
    proc
  89. var driveRand: Boolean

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

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

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

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

    Definition Classes
    Node
  93. def error(b: Bits): Bits

    Error shown when operation is not defined

    Error shown when operation is not defined

    Definition Classes
    Bits
    Exceptions thrown
    ChiselException

    if the operation is not defined

  94. def finalize(): Unit

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

    Definition Classes
    BitsData
  96. def flip(): SInt.this.type

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Definition Classes
    BitsData
  97. def floLitValue: Float

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  98. def forceMatchingWidths: Unit

    Force the width of this nodes input to have the same width this if known if input node width is known force width of this node

    Force the width of this nodes input to have the same width this if known if input node width is known force width of this node

    Definition Classes
    BitsNode
  99. def fromBits(b: Bits): SInt.this.type

    Definition Classes
    Data
  100. def fromInt(x: Int): SInt.this.type

    Set the value of this SInt to a value

    Set the value of this SInt to a value

    Definition Classes
    SIntBits
  101. def fromNode(n: Node): SInt.this.type

    Factory method to create and assign a *SInt* type to a Node *n*.

    Factory method to create and assign a *SInt* type to a Node *n*.

    Definition Classes
    SIntData
  102. def gen[T <: Bits](): T

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

    Definition Classes
    AnyRef → Any
  104. def getNode: Node

    returns

    The root node input

    Definition Classes
    BitsNode
  105. def getWidth(): Int

    returns

    the width or number of bits used by this node

    Definition Classes
    Node
    Exceptions thrown
    ChiselException

    if the width of the node is unknown

  106. def hashCode(): Int

    returns

    the unique hashCode for this node

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

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

    Attributes
    protected
    Definition Classes
    Data
  109. def infer: Boolean

    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
  110. def init(n: String, w: Int, ins: Node*): Node

    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
  111. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

    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
  112. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Seq[Node]): Node

    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
  113. val inputs: ArrayBuffer[Node]

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  114. def isDirectionless: Boolean

    returns

    this instantiation is neither of INPUT or OUTPUT

    Definition Classes
    BitsData
  115. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  116. def isIo: Boolean

    returns

    this node is an I/O Node for a module

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

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

    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
  119. def isTopLevelIO: Boolean

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  120. var isTypeNode: Boolean

    Definition Classes
    Node
  121. def isTypeOnly: Boolean

    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
  122. def isUsedByClockHi: Boolean

    returns

    this node is a Register

    Definition Classes
    Node
  123. def isWired: Boolean

    Definition Classes
    Data
  124. def isZeroWidth: Boolean

    returns

    this node has zero-width

    Definition Classes
    Node
  125. val line: StackTraceElement

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  126. def litOf: Literal

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown
    ChiselException

    if there is no literal value available

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

    returns

    the literal value of the node as a BigInt

    Bool(true).litValue() => BigInt(1)
    Definition Classes
    Node
  128. def matchWidth(w: Width): Node

    Definition Classes
    SIntBitsNode
  129. def max(b: SInt): SInt

    Definition Classes
    Num
  130. def maybeFlatten: Seq[Node]

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  131. def min(b: SInt): SInt

    Definition Classes
    Num
  132. var modified: Boolean

    Definition Classes
    Node
  133. def muxes: Seq[Mux]

    Attributes
    protected[Chisel]
    Definition Classes
    proc
  134. var name: String

    Name of the instance.

    Name of the instance.

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

    name this node

    name this node

    Definition Classes
    DataNode
    Note

    use setName in Node rather than this directly

  136. var named: Boolean

    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
  137. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  138. def needWidth(): Int

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown
    ChiselException

    if the width is not yet defined

  139. final def newBinaryOp(right: Bits, opName: String): SInt.this.type

    Attributes
    protected
    Definition Classes
    Bits
  140. final def newLogicalOp(right: Bits, opName: String): Bool

    Attributes
    protected
    Definition Classes
    Bits
  141. final def newReductionOp(opName: String): Bool

    Attributes
    protected
    Definition Classes
    Bits
  142. final def newUnaryOp(opName: String): SInt.this.type

    Attributes
    protected
    Definition Classes
    Bits
  143. def next: Node

    Attributes
    protected[Chisel]
    Definition Classes
    proc
  144. def nextOpt: Option[Node]

    Attributes
    protected[Chisel]
    Definition Classes
    proc
  145. final def notify(): Unit

    Definition Classes
    AnyRef
  146. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  147. def orR(): Bool

    reduction or, or all bits together

    reduction or, or all bits together

    Definition Classes
    Bits
  148. def params: Parameters

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

    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
  150. def procAssign(src: Node): Unit

    Definition Classes
    Bitsproc
  151. var procAssigned: Boolean

    Attributes
    protected
    Definition Classes
    proc
  152. var prune: Boolean

    Definition Classes
    Node
  153. def replaceTree(newNode: Node): Unit

    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
  154. def review(): Unit

    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
  155. def setDefault(src: Node): Unit

    Attributes
    protected
    Definition Classes
    proc
  156. def setIsTypeNode: Unit

    make this node a type node

    make this node a type node

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

    Definition Classes
    Data
  158. def setName(n: String): Unit

    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")
  159. def setWidth(w: Int): Unit

    Force the bit width of a node

    Force the bit width of a node

    w

    the bit width to force

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

    Definition Classes
    AnyRef
  161. def toBits(): UInt

    returns

    This node as a UInt

    Definition Classes
    Node
  162. def toBool(): Bool

    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

  163. def toBools: Vec[Bool]

    Split up this bits instantiation to a Vec of Bools

    Split up this bits instantiation to a Vec of Bools

    Definition Classes
    Bits
  164. lazy val toNode: Node

    Definition Classes
    DataNode
  165. def toSInt(): SInt

    Definition Classes
    Bits
  166. def toString(): String

    Definition Classes
    Bits → AnyRef → Any
  167. def toUInt(): UInt

    Definition Classes
    Bits
  168. def unary_!(): Bool

  169. def unary_-(): SInt

    Definition Classes
    SIntNum
  170. def unary_~(): SInt.this.type

    invert all bits with ~

    invert all bits with ~

    Definition Classes
    Bits
  171. def usesInClockHi(i: Node): Boolean

    Definition Classes
    Node
  172. def verifyMuxes: Unit

    Attributes
    protected[Chisel]
    Definition Classes
    proc
  173. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  176. def xorR(): Bool

    reduction xor, xor all bits together

    reduction xor, xor all bits together

    Definition Classes
    Bits
  177. def |(b: Bits): SInt.this.type

    Bitwise or

    Bitwise or

    Definition Classes
    Bits

Deprecated Value Members

  1. def !=(b: UInt): Bool

    Annotations
    @deprecated
    Deprecated

    (Since version 3) Use =/= rather than !=

  2. def !=(that: BitPat): Bool

    Definition Classes
    Bits
    Annotations
    @deprecated
    Deprecated

    (Since version 3) Use =/= rather than != for chisel comparison

  3. def !=(b: Bits): Bool

    Definition Classes
    Bits
    Annotations
    @deprecated
    Deprecated

    (Since version 3) Use =/= rather than != for chisel comparison

Inherited from Num[SInt]

Inherited from Bits

Inherited from proc

Inherited from Data

Inherited from Node

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped