Packages

class SInt extends BitVector with Num[SInt] with MinMaxProvider with DataPrimitives[SInt] with BaseTypePrimitives[SInt] with BitwiseOp[SInt]

The SInt type corresponds to a vector of bits that can be used for signed integer arithmetic.

Example: 

  1. val mySInt = SInt(8 bits)
mySInt    := S(4, 8 bits) + S"0000_1111"
mySInt    := S(4) - S"h1A"
See also

SInt Documentation

Linear Supertypes
BitwiseOp[SInt], BaseTypePrimitives[SInt], DataPrimitives[SInt], MinMaxProvider, Num[SInt], BitVector, Widthable, WidthProvider, BaseType, Expression, StatementDoubleLinkedContainer[BaseType, AssignmentStatement], DoubleLinkedContainer[BaseType, AssignmentStatement], DeclarationStatement, LeafStatement, Statement, BaseNode, ExpressionContainer, Data, InComponent, OverridedEqualsHashCode, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SInt
  2. BitwiseOp
  3. BaseTypePrimitives
  4. DataPrimitives
  5. MinMaxProvider
  6. Num
  7. BitVector
  8. Widthable
  9. WidthProvider
  10. BaseType
  11. Expression
  12. StatementDoubleLinkedContainer
  13. DoubleLinkedContainer
  14. DeclarationStatement
  15. LeafStatement
  16. Statement
  17. BaseNode
  18. ExpressionContainer
  19. Data
  20. InComponent
  21. OverridedEqualsHashCode
  22. SpinalTagReady
  23. Assignable
  24. NameableByComponent
  25. Nameable
  26. OwnableRef
  27. ContextUser
  28. ScalaLocated
  29. GlobalDataUser
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SInt()

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef
  2. type T = SInt

    Used to know the data type of the children class of BitVector

    Used to know the data type of the children class of BitVector

    Definition Classes
    SInt → BitVector

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. def %(right: SInt): SInt

    Modulo

    Modulo

    Definition Classes
    SInt → Num
  6. def &(right: SInt): SInt

    Bitwise AND operator

    Bitwise AND operator

    Definition Classes
    SInt → BitwiseOp
  7. def *(right: SInt): SInt

    Multiplication

    Multiplication

    Definition Classes
    SInt → Num
  8. def +(right: SInt): SInt

    Addition

    Addition

    Definition Classes
    SInt → Num
  9. def +^(right: SInt): SInt

    Safe Addition with 1 bit expand

    Safe Addition with 1 bit expand

    Definition Classes
    SInt → Num
  10. def +|(right: SInt): SInt

    Safe Addition with saturation

    Safe Addition with saturation

    Definition Classes
    SInt → Num
  11. def -(right: SInt): SInt

    Substraction

    Substraction

    Definition Classes
    SInt → Num
  12. def -^(right: SInt): SInt

    Safe Substraction with 1 bit expand

    Safe Substraction with 1 bit expand

    Definition Classes
    SInt → Num
  13. def -|(right: SInt): SInt

    Safe Substraction with saturation

    Safe Substraction with saturation

    Definition Classes
    SInt → Num
  14. def /(right: SInt): SInt

    Division

    Division

    Definition Classes
    SInt → Num
  15. def :=(value: String): Unit
  16. def :=(rangesValue: (Any, Any), _rangesValues: (Any, Any)*): Unit

    Assign a range value to a SInt

    Assign a range value to a SInt

    rangesValue

    The first range value

    _rangesValues

    Others range values

    Example: 

    1. core.io.interrupt = (0 -> uartCtrl.io.interrupt, 1 -> timerCtrl.io.interrupt, default -> false)
  17. def :=(that: SInt)(implicit loc: Location): Unit

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  18. def <(right: SInt): Bool

    Is less than right

    Is less than right

    Definition Classes
    SInt → Num
  19. def <<(that: UInt): SInt

    Logical shift Left (output width will increase of : w(this) + max(that) bits

  20. def <<(that: Int): SInt

    Logical left shift (w(T) = w(this) + shift)

    Logical left shift (w(T) = w(this) + shift)

    Definition Classes
    SInt → Num
  21. def <=(right: SInt): Bool

    Is equal or less than right

    Is equal or less than right

    Definition Classes
    SInt → Num
  22. def <>(that: SInt)(implicit loc: Location): Unit

    Auto connection between two data

    Auto connection between two data

    Definition Classes
    DataPrimitives
  23. def =/=(that: SInt): Bool
    Definition Classes
    DataPrimitives
  24. def =/=(that: MaskedLiteral): Bool

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

    Definition Classes
    BitVector
  25. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  26. def ===(that: SInt): Bool

    Comparison between two data

    Comparison between two data

    Definition Classes
    DataPrimitives
  27. def ===(that: MaskedLiteral): Bool

    Compare a BitVector with a MaskedLiteral (M"110--0")

    Compare a BitVector with a MaskedLiteral (M"110--0")

    that

    the maskedLiteral

    returns

    a Bool data containing the result of the comparison

    Definition Classes
    BitVector
    Example: 

    1. val myBool = myBits === M"0-1"
  28. def >(right: SInt): Bool

    Is greater than right

    Is greater than right

    Definition Classes
    SInt → Num
  29. def >=(right: SInt): Bool

    Is equal or greater than right

    Is equal or greater than right

    Definition Classes
    SInt → Num
  30. def >>(that: UInt): SInt

    Logical shift Right (output width == input width)

    Logical shift Right (output width == input width)

    that

    the number of right shift

    returns

    a Bits of width : w(this)

    Example: 

    1. val result = mySInt >> myUIntShift
  31. def >>(that: Int): SInt

    Logical right shift (w(T) = w(this) - shift)

    Logical right shift (w(T) = w(this) - shift)

    Definition Classes
    SInt → Num
  32. def @@(that: Bool): SInt

    Concatenation between a SInt and a Bool

  33. def @@(that: UInt): SInt

    Concatenation between a SInt and UInt

  34. def @@(that: SInt): SInt

    Concatenation between two SInt

    Concatenation between two SInt

    that

    an SInt to append

    returns

    a new SInt of width (width(this) + width(right))

    Example: 

    1. val mySInt = sInt1 @@ sInt2
  35. def Q: QFormat
    Definition Classes
    Num
  36. def \(that: SInt): SInt

    Use as \= to have the same behavioral as VHDL variable

    Use as \= to have the same behavioral as VHDL variable

    Definition Classes
    DataPrimitives
  37. def ^(right: SInt): SInt

    Bitwise XOR operator

    Bitwise XOR operator

    Definition Classes
    SInt → BitwiseOp
  38. def _fixEntry(roundN: Int, roundType: RoundType, satN: Int): SInt
    Attributes
    protected
  39. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  40. def addAttribute(attribute: Attribute): SInt.this.type
    Definition Classes
    BaseType → Data → SpinalTagReady
  41. def addAttribute(name: String, value: Int): SInt.this.type
    Definition Classes
    SpinalTagReady
  42. def addAttribute(name: String, value: String): SInt.this.type
    Definition Classes
    SpinalTagReady
  43. def addAttribute(name: String): SInt.this.type
    Definition Classes
    SpinalTagReady
  44. def addTag[T <: SpinalTag](spinalTag: T): SInt.this.type
    Definition Classes
    SpinalTagReady
  45. def addTags[T <: SpinalTag](tags: Iterable[T]): SInt.this.type
    Definition Classes
    SpinalTagReady
  46. val algoIncrementale: Int
    Definition Classes
    BaseNode
  47. val algoInt: Int
    Definition Classes
    BaseNode
  48. def allowDirectionLessIo(): SInt.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

    Definition Classes
    Data
  49. def allowOverride(): SInt.this.type

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  50. def allowPartialyAssigned(): SInt.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  51. def allowPruning(): SInt.this.type
    Definition Classes
    Data
  52. def allowSimplifyIt(): SInt.this.type
    Definition Classes
    BaseType → Data
  53. def allowUnsetRegToAvoidLatch(): SInt.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  54. def andMask(that: Bool): SInt.this.type
    Definition Classes
    BitVector
  55. def andR: Bool

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  56. def apply(offset: UInt, bitCount: BitCount): SInt.this.type

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    SInt → BitVector
    Example: 

    1. val myBool = myBits(myUInt, 2 bits)
  57. def apply(offset: Int, bitCount: BitCount): SInt.this.type

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    SInt → BitVector
    Example: 

    1. val myBool = myBits(3, 2 bits)
  58. def apply(bitId: UInt): Bool

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    SInt → BitVector
    Example: 

    1. val myBool = myBits(myUInt)
  59. def apply(bitId: Int): Bool

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    SInt → BitVector
    Example: 

    1. val myBool = myBits(3)
  60. def apply(range: Range): SInt.this.type

    Return a range of bits

    Return a range of bits

    Definition Classes
    BitVector
    Example: 

    1. val myBool = myBits(3 downto 1)
  61. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  62. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    SInt → Data
  63. def asBool: Bool
    Definition Classes
    BitVector
  64. def asBools: Vec[Bool]

    Cast the BitVector into a Vector of Bool

    Cast the BitVector into a Vector of Bool

    returns

    a vector of Bool

    Definition Classes
    BitVector
  65. def asData: Data
    Definition Classes
    Data
  66. def asInOut(): SInt.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseType → Data
  67. def asInput(): SInt.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    BaseType → Data
  68. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  69. def asOutput(): SInt.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  70. def asUInt: UInt

    Cast a SInt into an UInt

    Cast a SInt into an UInt

    returns

    a UInt data

    Example: 

    1. myUInt := mySInt.asUInt
  71. def assignDontCare(): SInt.this.type
    Definition Classes
    SInt → Data
  72. def assignDontCareToUnasigned(): SInt.this.type
    Definition Classes
    Data
  73. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    SInt → Data
  74. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  75. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    SInt → Data
  76. def assignFromBits(bits: Bits): Unit
    Definition Classes
    SInt → Data
  77. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  78. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    BaseType → Assignable
  79. def bitsRange: Range
    Definition Classes
    BitVector
  80. def ceil(n: Int, align: Boolean = true): SInt

    SInt ceil

    SInt ceil

    n

    : ceil lowerest n bit

    returns

    a new SInt of width (w - n + 1)

    Definition Classes
    SInt → Num
    Example: 

    1. val mySInt = SInt(w bits).ceil
  81. def ceil(width: BitCount, align: Boolean): SInt

    lowest n bits Round Operation by BitCount

    lowest n bits Round Operation by BitCount

    Definition Classes
    Num
  82. def ceilToInf(n: Int, align: Boolean = true): SInt

    SInt roundUp lowest m bits, friendly for hardware timing and area sign * ceil(abs(x))

    SInt roundUp lowest m bits, friendly for hardware timing and area sign * ceil(abs(x))

    Definition Classes
    SInt → Num
  83. def ceilToInf(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  84. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  85. def clearAll(): SInt.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector → Data
  86. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  87. def clone(): SInt.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  88. def component: Component
    Definition Classes
    ContextUser
  89. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  90. val compositeAssign: Assignable
    Definition Classes
    Assignable
  91. def copyDirectionOf(that: SInt): Unit
    Definition Classes
    DataPrimitives
  92. def copyDirectionOfImpl(that: Data): SInt.this.type
    Definition Classes
    BaseType → Data
  93. def default(that: ⇒ SInt): SInt

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  94. def dirString(): String
    Definition Classes
    Data
  95. def dlcAppend(that: AssignmentStatement): SInt.this.type
    Definition Classes
    DoubleLinkedContainer
  96. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  97. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  98. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  99. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  100. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  101. def dlcPrepend(that: AssignmentStatement): SInt.this.type
    Definition Classes
    DoubleLinkedContainer
  102. def dontSimplifyIt(): SInt.this.type
    Definition Classes
    BaseType → Data
  103. def drop(n: Int): Bits

    Drop lowerst n bits

    Drop lowerst n bits

    returns

    data10bits(9 downto 4)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.drop(4)
  104. def dropHigh(n: Int): Bits

    Drop highest n bits

    Drop highest n bits

    returns

    data10bits(5 downto 0)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.dropHigh(4)
  105. def dropLow(n: Int): Bits
    Definition Classes
    BitVector
  106. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  107. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  108. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  109. def expand: SInt
  110. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  111. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  112. def fixTo(q: QFormat): SInt
  113. def fixTo(q: QFormat, roundType: RoundType): SInt
  114. def fixTo(q: QFormat, roundType: RoundType, sym: Boolean): SInt
  115. def fixTo(section: Inclusive): SInt
  116. def fixTo(section: Inclusive, roundType: RoundType): SInt
  117. def fixTo(section: Inclusive, roundType: RoundType, sym: Boolean): SInt
  118. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  119. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    BaseType → Data
  120. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  121. def flip(): SInt.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  122. def floor(n: Int): SInt

    return w(this)-n bits

    return w(this)-n bits

    Definition Classes
    SInt → Num
  123. def floor(width: BitCount): SInt
    Definition Classes
    Num
  124. def floorToZero(n: Int): SInt

    SInt roundUp lowest m bits, friendly for hardware timing and area sign * floor(abs(x))

    SInt roundUp lowest m bits, friendly for hardware timing and area sign * floor(abs(x))

    Definition Classes
    SInt → Num
  125. def floorToZero(width: BitCount): SInt
    Definition Classes
    Num
  126. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit
    Definition Classes
    BaseType → Statement
  127. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  128. def foreachExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  129. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  130. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  131. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  132. def freeze(): SInt.this.type
    Definition Classes
    BaseType → Data
  133. def getAheadValue(): SInt.this.type
    Definition Classes
    BaseType → Data
  134. def getAllTrue: SInt.this.type
    Definition Classes
    SInt → BitVector
  135. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVector → Data
  136. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  137. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  138. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  139. def getDirection: IODirection
    Definition Classes
    Data
  140. def getDisplayName(): String
    Definition Classes
    Nameable
  141. def getDrivingReg(reportError: Boolean = true): SInt.this.type
    Definition Classes
    BaseType
  142. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  143. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  144. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    BitVector → Data
  145. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  146. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  147. def getPartialName(): String
    Definition Classes
    Nameable
  148. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  149. def getRealSource: Any
    Definition Classes
    Assignable
  150. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  151. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  152. def getRootParent: Data
    Definition Classes
    Data
  153. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  154. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  155. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  156. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  157. def getSingleDriver: Option[SInt.this.type]
    Definition Classes
    BaseType
  158. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  159. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  160. def getTypeObject: TypeSInt.type
    Definition Classes
    SInt → Expression
  161. def getWidth: Int
    Definition Classes
    Widthable → WidthProvider
  162. def getWidthNoInferation: Int

    Return the width

    Return the width

    Definition Classes
    BitVector
  163. def getWidthStringNoInferation: String
    Definition Classes
    BitVector
  164. def getZero: SInt.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    SInt → Data
  165. def getZeroUnconstrained: SInt.this.type
    Definition Classes
    SInt → BitVector
  166. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  167. def hasAssignement: Boolean
    Definition Classes
    BaseType
  168. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  169. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  170. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  171. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  172. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  173. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  174. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  175. def high: Int

    Return the upper bound

    Return the upper bound

    Definition Classes
    BitVector
  176. def init(that: SInt): SInt

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  177. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  178. def initial(that: SInt): SInt
    Definition Classes
    BaseTypePrimitives
  179. def initialFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    BaseType
  180. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  181. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  182. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  183. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  184. def isComb: Boolean
    Definition Classes
    BaseType → Data
  185. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  186. def isDirectionLess: Boolean
    Definition Classes
    Data
  187. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  188. def isFrozen(): Boolean
    Definition Classes
    BaseType
  189. def isInOut: Boolean
    Definition Classes
    Data
  190. def isInput: Boolean
    Definition Classes
    Data
  191. def isInputOrInOut: Boolean
    Definition Classes
    Data
  192. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  193. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  194. def isOutput: Boolean
    Definition Classes
    Data
  195. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  196. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  197. def isReg: Boolean
    Definition Classes
    BaseType → Data
  198. def isRegOnAssign: Boolean
    Definition Classes
    BitVector → Data
  199. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  200. def isUnknown: Bool
    Definition Classes
    BitVector
  201. def isUnnamed: Boolean
    Definition Classes
    Nameable
  202. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  203. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  204. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  205. val lastScopeStatement: Statement
    Definition Classes
    Statement
  206. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  207. def max(right: SInt): SInt

    Return the maximum value between this and right

    Return the maximum value between this and right

    Definition Classes
    Num
  208. def maxValue: BigInt
    Definition Classes
    SInt → MinMaxProvider
  209. def min(right: SInt): SInt

    Return the minimum value between this and right

    Return the minimum value between this and right

    Definition Classes
    Num
  210. def minValue: BigInt
    Definition Classes
    SInt → MinMaxProvider
  211. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  212. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  213. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  214. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  215. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  216. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  217. val name: String
    Definition Classes
    Nameable
  218. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  219. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  220. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating)(implicit loc: Location): SInt.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

    Definition Classes
    BitVector
  221. def newExtract(hi: Int, lo: Int, accessFactory: ⇒ BitVectorRangedAccessFixed): SInt.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

    Definition Classes
    BitVector
  222. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  223. def newExtract(bitId: Int, extract: BitVectorBitAccessFixed): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  224. val nextScopeStatement: Statement
    Definition Classes
    Statement
  225. def noBackendCombMerge(): SInt.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  226. def noCombLoopCheck(): SInt.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  227. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  228. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  229. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  230. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  231. def opName: String
    Definition Classes
    SInt → Expression
  232. def orMask(that: Bool): SInt.this.type
    Definition Classes
    BitVector
  233. def orR: Bool

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  234. def overrideLocalName(name: String): SInt.this.type
    Definition Classes
    Nameable
  235. val parent: Data
    Definition Classes
    Data
  236. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  237. def pull(propagateName: Boolean): SInt.this.type
    Definition Classes
    Data
  238. def pull(): SInt.this.type

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  239. def purify(): SInt.this.type
    Definition Classes
    Data
  240. def randBoot(u: Unit): SInt.this.type

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  241. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  242. def reflectNames(): Unit
    Definition Classes
    Nameable
  243. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  244. def remapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  245. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): SInt.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  246. def removeDataAssignments(): SInt.this.type
    Definition Classes
    Data
  247. def removeInitAssignments(): SInt.this.type
    Definition Classes
    Data
  248. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  249. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  250. def removeTag(spinalTag: SpinalTag): SInt.this.type
    Definition Classes
    SpinalTagReady
  251. def removeTags(tags: Iterable[SpinalTag]): SInt.this.type
    Definition Classes
    SpinalTagReady
  252. def resize(width: BitCount): SInt
    Definition Classes
    SInt → BitVector
  253. def resize(width: Int): SInt.this.type

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Definition Classes
    SInt → BitVector
    Example: 

    1. val res = myBits.resize(10)
  254. def resized: SInt.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  255. def reversed: SInt.this.type
    Definition Classes
    SInt → BitVector
  256. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  257. def rootIFList(): List[Interface]
    Definition Classes
    Data
  258. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  259. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  260. def rotateLeft(that: Int): SInt

    Left rotation of that bits

    Left rotation of that bits

    Definition Classes
    SInt → BitVector
  261. def rotateLeft(that: UInt): T

    Left rotation of that Bits

    Left rotation of that Bits

    Definition Classes
    BitVector
  262. def rotateRight(that: Int): SInt

    Right rotation of that bits

    Right rotation of that bits

    Definition Classes
    SInt → BitVector
  263. def rotateRight(that: UInt): T

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  264. def round(n: Int, align: Boolean = true): SInt
    Definition Classes
    SInt → Num
  265. def round(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  266. def roundDown(n: Int, align: Boolean): SInt

    SInt roundDown lowest m bits, complex for hardware , not recommended The algorithm represented by python code : ceil(x - 0.5)

    SInt roundDown lowest m bits, complex for hardware , not recommended The algorithm represented by python code : ceil(x - 0.5)

    Definition Classes
    SInt → Num
  267. def roundDown(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  268. def roundToEven(n: Int, align: Boolean): SInt
    Definition Classes
    SInt → Num
  269. def roundToEven(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  270. def roundToInf(n: Int, align: Boolean = true): SInt

    SInt roundToInf sign * floor(abs(x) + 0.5)

    SInt roundToInf sign * floor(abs(x) + 0.5)

    Definition Classes
    SInt → Num
  271. def roundToInf(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  272. def roundToOdd(n: Int, align: Boolean): SInt
    Definition Classes
    SInt → Num
  273. def roundToOdd(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  274. def roundToZero(n: Int, align: Boolean): SInt

    SInt roundToZero The algorithm represented by python code : sign * ceil(abs(x) - 0.5)

    SInt roundToZero The algorithm represented by python code : sign * ceil(abs(x) - 0.5)

    Definition Classes
    SInt → Num
  275. def roundToZero(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  276. def roundUp(n: Int, align: Boolean = true): SInt

    SInt roundUp lowest m bits, friendly for hardware timing and area floor(x + 0.5)

    SInt roundUp lowest m bits, friendly for hardware timing and area floor(x + 0.5)

    Definition Classes
    SInt → Num
  277. def roundUp(width: BitCount, align: Boolean): SInt
    Definition Classes
    Num
  278. def sat(m: Int): SInt

    Saturation highest m bits

    Saturation highest m bits

    Definition Classes
    SInt → Num
  279. def sat(width: BitCount): SInt
    Definition Classes
    Num
  280. def satWithSym(m: Int): SInt
  281. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  282. def setAll(): SInt.this.type

    Set all bits

    Set all bits

    Definition Classes
    SInt → BitVector → Data
  283. def setAllTo(value: Bool): SInt.this.type

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  284. def setAllTo(value: Boolean): SInt.this.type

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  285. def setAsAnalog(): SInt.this.type
    Definition Classes
    BaseType → Data
  286. def setAsComb(): SInt.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  287. def setAsDirectionLess(): SInt.this.type

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    BaseType → Data
  288. def setAsReg(): SInt.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType → Data
  289. def setAsTypeNode(): SInt.this.type

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  290. def setAsVital(): SInt.this.type

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  291. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SInt.this.type
    Definition Classes
    Nameable
  292. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SInt.this.type
    Definition Classes
    Nameable
  293. def setCompositeName(nameable: Nameable, postfix: String): SInt.this.type
    Definition Classes
    Nameable
  294. def setCompositeName(nameable: Nameable, namePriority: Byte): SInt.this.type
    Definition Classes
    Nameable
  295. def setCompositeName(nameable: Nameable, weak: Boolean): SInt.this.type
    Definition Classes
    Nameable
  296. def setCompositeName(nameable: Nameable): SInt.this.type
    Definition Classes
    Nameable
  297. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): SInt.this.type
    Definition Classes
    Nameable
  298. def setName(name: String, namePriority: Byte): SInt.this.type
    Definition Classes
    Nameable
  299. def setName(name: String, weak: Boolean): SInt.this.type
    Definition Classes
    Nameable
  300. def setName(name: String): SInt.this.type
    Definition Classes
    Nameable
  301. def setNameAsWeak(): SInt.this.type
    Definition Classes
    Nameable
  302. def setOutputAsReg(): SInt.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  303. def setPartialName(name: String, namePriority: Byte, owner: Any): SInt.this.type
    Definition Classes
    Nameable
  304. def setPartialName(name: String, namePriority: Byte): SInt.this.type
    Definition Classes
    Nameable
  305. def setPartialName(name: String, weak: Boolean): SInt.this.type
    Definition Classes
    Nameable
  306. def setPartialName(owner: Nameable, name: String, namePriority: Byte): SInt.this.type
    Definition Classes
    Nameable
  307. def setPartialName(owner: Nameable, name: String, weak: Boolean): SInt.this.type
    Definition Classes
    Nameable
  308. def setPartialName(name: String): SInt.this.type
    Definition Classes
    Nameable
  309. def setPartialName(owner: Nameable, name: String): SInt.this.type
    Definition Classes
    Nameable
  310. def setPartialName(owner: Nameable): SInt.this.type
    Definition Classes
    Nameable
  311. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  312. def setScalaLocated(source: ScalaLocated): SInt.this.type
    Definition Classes
    ScalaLocated
  313. def setWeakName(name: String): SInt.this.type
    Definition Classes
    Nameable
  314. def setWidth(width: Int): SInt.this.type

    Set the width of the BitVector

    Set the width of the BitVector

    width

    the width of the data

    returns

    the BitVector of a given size

    Definition Classes
    BitVector
  315. def sign: Bool
  316. def simplifyNode: Expression
    Definition Classes
    Expression
  317. def sliceBy(divisor: List[Int]): List[Bits]
    Definition Classes
    BitVector
  318. def sliceBy(divisor: Int*): List[Bits]

    apart by a list of width

    apart by a list of width

    returns

    (List(A(1 downto 0), A(2 downto 4), A(9 downto 3))

    Definition Classes
    BitVector
    Example: 

    1. val res = A.sliceBy(2, 3, 5)
val res = A.sliceBy(List(2, 3, 5))
  319. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  320. def splitAt(n: Int): (Bits, Bits)

    Split at n st bits

    Split at n st bits

    returns

    (data10bits(8 downto 4), data10bits(3 downto 0))

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.splitAt(4)
  321. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  322. def subdivideIn(sliceWidth: BitCount): Vec[T]
    Definition Classes
    BitVector
  323. def subdivideIn(sliceCount: SlicesCount): Vec[T]
    Definition Classes
    BitVector
  324. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

    Split the BitVector into slice of x bits

    Split the BitVector into slice of x bits

    sliceWidth

    the width of the slice

    strict

    allow subdivideIn to generate vectors with varying size

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example: 

    1. val res = myBits.subdivideIn(3 bits)
  325. def subdivideIn(sliceCount: SlicesCount, strict: Boolean): Vec[T]

    Split the BitVector into x slice

    Split the BitVector into x slice

    sliceCount

    the width of the slice

    strict

    allow subdivideIn to generate vectors with varying size

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example: 

    1. val res = myBits.subdivideIn(3 slices)
  326. def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, SInt)*): Unit
    Definition Classes
    DataPrimitives
  327. def symmetry: SInt

    SInt symmetric

    SInt symmetric

    returns

    return a SInt which minValue equal -maxValue

    Example: 

    1. val symmetrySInt = mySInt.symmetry
  328. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  329. def tag(q: QFormat): SInt
    Definition Classes
    SInt → Num
  330. def take(n: Int): Bits

    Take lowerst n bits

    Take lowerst n bits

    returns

    data10bits(3 downto 0)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.take(4)
  331. def takeHigh(n: Int): Bits

    Take highest n bits

    Take highest n bits

    returns

    data10bits(9 downto 6)

    Definition Classes
    BitVector
    Example: 

    1. val res = data10bits.takeHigh(4)
  332. def takeLow(n: Int): Bits
    Definition Classes
    BitVector
  333. def toIo(): SInt.this.type
    Definition Classes
    Data
  334. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  335. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  336. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  337. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  338. def trim(m: Int): SInt

    highest m bits Discard

    highest m bits Discard

    Definition Classes
    SInt → Num
  339. def trim(width: BitCount): SInt
    Definition Classes
    Num
  340. def unary_-: SInt

    Negative number

    Negative number

    returns

    return a negative number

    Example: 

    1. val result = -mySInt
  341. def unary_~: SInt

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    SInt → BitwiseOp
  342. def unfreeze(): SInt.this.type
    Definition Classes
    BaseType → Data
  343. def unsetName(): SInt.this.type
    Definition Classes
    Nameable
  344. def valueRange: Range
  345. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  346. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  347. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  348. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  349. def walkExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  350. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  351. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  352. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  353. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  354. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  355. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  356. def wrapNext(): SInt.this.type
    Definition Classes
    Data
  357. def xorMask(that: Bool): SInt.this.type
    Definition Classes
    BitVector
  358. def xorR: Bool

    Logical XOR of all bits

    Logical XOR of all bits

    Definition Classes
    BitVector
  359. def |(right: SInt): SInt

    Bitwise OR operator

    Bitwise OR operator

    Definition Classes
    SInt → BitwiseOp
  360. def |<<(that: UInt): SInt

    Logical shift left (output width == input width)

  361. def |<<(that: Int): SInt

    Logical shift left (output width == input width)

  362. def |>>(that: UInt): SInt

    Logical shift Right (output width == input width)

  363. def |>>(that: Int): SInt

    Logical shift right (output width == input width)

    Logical shift right (output width == input width)

    that

    the number of right shift

    returns

    a Bits of width : w(this)

    Example: 

    1. val result = myUInt |>> 4

Deprecated Value Members

  1. def asDirectionLess(): SInt.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  3. def genIf(cond: Boolean): SInt.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

  4. def range: Range

    Return the range

    Return the range

    Definition Classes
    BitVector
    Annotations
    @deprecated
    Deprecated

    Use bitsRange instead

Inherited from BitwiseOp[SInt]

Inherited from BaseTypePrimitives[SInt]

Inherited from DataPrimitives[SInt]

Inherited from MinMaxProvider

Inherited from Num[SInt]

Inherited from BitVector

Inherited from Widthable

Inherited from WidthProvider

Inherited from BaseType

Inherited from Expression

Inherited from StatementDoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DeclarationStatement

Inherited from LeafStatement

Inherited from Statement

Inherited from BaseNode

Inherited from ExpressionContainer

Inherited from Data

Inherited from InComponent

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped