Class

spinal.core

UInt

Related Doc: package core

Permalink

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

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

Example:
  1. val myUInt = UInt(8 bits)
     myUInt := U(2,8 bits)
     myUInt := U(2)
     myUInt := U"0000_0101"
     myUInt := U"h1A"
See also

UInt Documentation

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UInt
  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 UInt()

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  2. type T = UInt

    Permalink

    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
    UIntBitVector

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def %(right: UInt): UInt

    Permalink

    Modulo

    Modulo

    Definition Classes
    UIntNum
  5. def &(right: UInt): UInt

    Permalink

    Logical AND operator

    Logical AND operator

    Definition Classes
    UIntBitwiseOp
  6. def *(right: UInt): UInt

    Permalink

    Multiplication

    Multiplication

    Definition Classes
    UIntNum
  7. def +(right: UInt): UInt

    Permalink

    Addition

    Addition

    Definition Classes
    UIntNum
  8. def +^(right: UInt): UInt

    Permalink

    Safe Addition with 1 bit expand

    Safe Addition with 1 bit expand

    Definition Classes
    UIntNum
  9. def +|(right: UInt): UInt

    Permalink

    Safe Addition with saturation

    Safe Addition with saturation

    Definition Classes
    UIntNum
  10. def -(right: UInt): UInt

    Permalink

    Substraction

    Substraction

    Definition Classes
    UIntNum
  11. def -^(right: UInt): UInt

    Permalink

    Safe Substraction with 1 bit expand

    Safe Substraction with 1 bit expand

    Definition Classes
    UIntNum
  12. def -|(right: UInt): UInt

    Permalink

    Safe Substraction with saturation

    Safe Substraction with saturation

    Definition Classes
    UIntNum
  13. def /(right: UInt): UInt

    Permalink

    Division

    Division

    Definition Classes
    UIntNum
  14. def :=(value: String): Unit

    Permalink
  15. def :=(rangesValue: (Any, Any), _rangesValues: (Any, Any)*): Unit

    Permalink

    Assign a range value to an UInt

    Assign a range value to an UInt

    rangesValue

    The first range value

    _rangesValues

    Others range values

    Example:
    1. core.io.interrupt = (0 -> uartCtrl.io.interrupt, 1 -> timerCtrl.io.interrupt, default -> false)
  16. def :=(that: UInt): Unit

    Permalink

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  17. def <(right: UInt): Bool

    Permalink

    Is less than right

    Is less than right

    Definition Classes
    UIntNum
  18. def <<(that: UInt): UInt

    Permalink

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

  19. def <<(that: Int): UInt

    Permalink

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

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

    Definition Classes
    UIntNum
  20. def <=(right: UInt): Bool

    Permalink

    Is equal or less than right

    Is equal or less than right

    Definition Classes
    UIntNum
  21. def <>(that: UInt): Unit

    Permalink

    Auto connection between two data

    Auto connection between two data

    Definition Classes
    DataPrimitives
  22. def =/=(that: UInt): Bool

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

    Permalink

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

    Definition Classes
    BitVector
  24. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  25. def ===(that: UInt): Bool

    Permalink

    Comparison between two data

    Comparison between two data

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

    Permalink

    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"
  27. def >(right: UInt): Bool

    Permalink

    Is greater than right

    Is greater than right

    Definition Classes
    UIntNum
  28. def >=(right: UInt): Bool

    Permalink

    Is equal or greater than right

    Is equal or greater than right

    Definition Classes
    UIntNum
  29. def >>(that: UInt): UInt

    Permalink

    Logical shift Right (output width = input width)

    Logical shift Right (output width = input width)

    that

    the number of shift

    returns

    a Bits of width : w(this)

    Example:
    1. val result = myUInt >> myUIntShift
  30. def >>(that: Int): UInt

    Permalink

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

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

    Definition Classes
    UIntNum
  31. def @@(that: Bool): UInt

    Permalink

    Concatenation between a UInt and a Bool

  32. def @@(that: UInt): UInt

    Permalink

    Concatenation between two UInt

    Concatenation between two UInt

    that

    an UInt to append

    returns

    a new UInt of width (w(this) + w(right))

    Example:
    1. val myUInt = uInt1 @@ uInt2
  33. def Q: QFormat

    Permalink
    Definition Classes
    Num
  34. def \(that: UInt): UInt

    Permalink

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

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

    Definition Classes
    DataPrimitives
  35. def ^(right: UInt): UInt

    Permalink

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    UIntBitwiseOp
  36. def _data: UInt

    Permalink
    Definition Classes
    UIntDataPrimitives
  37. def _fixEntry(roundN: Int, roundType: RoundType, satN: Int): UInt

    Permalink
    Attributes
    protected
  38. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  39. def addAttribute(attribute: Attribute): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeDataSpinalTagReady
  40. def addAttribute(name: String, value: Int): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  41. def addAttribute(name: String, value: String): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  42. def addAttribute(name: String): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  43. def addTag[T <: SpinalTag](spinalTag: T): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  44. def addTags[T <: SpinalTag](tags: Iterable[T]): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  45. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  46. var algoInt: Int

    Permalink
    Definition Classes
    BaseNode
  47. def allowDirectionLessIo: UInt.this.type

    Permalink
    Definition Classes
    Data
  48. def allowOverride: UInt.this.type

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  49. def allowPartialyAssigned: UInt.this.type

    Permalink
    Definition Classes
    Data
  50. def allowPruning(): UInt.this.type

    Permalink
    Definition Classes
    Data
  51. def allowSimplifyIt(): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  52. def allowUnsetRegToAvoidLatch: UInt.this.type

    Permalink
    Definition Classes
    Data
  53. def andMask(that: Bool): UInt.this.type

    Permalink
    Definition Classes
    BitVector
  54. def andR: Bool

    Permalink

    Logical AND of all bits

    Logical AND of all bits

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

    Permalink

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    UIntBitVector
    Example:
    1. val myBool = myBits(myUInt, 2 bits)
  56. def apply(offset: Int, bitCount: BitCount): UInt.this.type

    Permalink

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Definition Classes
    UIntBitVector
    Example:
    1. val myBool = myBits(3, 2 bits)
  57. def apply(bitId: UInt): Bool

    Permalink

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UIntBitVector
    Example:
    1. val myBool = myBits(myUInt)
  58. def apply(bitId: Int): Bool

    Permalink

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UIntBitVector
    Example:
    1. val myBool = myBits(3)
  59. def apply(range: Range): UInt.this.type

    Permalink

    Return a range of bits

    Return a range of bits

    Definition Classes
    BitVector
    Example:
    1. val myBool = myBits(3 downto 1)
  60. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  61. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    UIntData
  62. def asBool: Bool

    Permalink
    Definition Classes
    BitVector
  63. def asBools: Vec[Bool]

    Permalink

    Cast the BitVector into a Vector of Bool

    Cast the BitVector into a Vector of Bool

    returns

    a vector of Bool

    Definition Classes
    BitVector
  64. def asData: Data

    Permalink
    Definition Classes
    Data
  65. def asInOut(): UInt.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    BaseTypeData
  66. def asInput(): UInt.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    BaseTypeData
  67. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  68. def asOutput(): UInt.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  69. def asSInt: SInt

    Permalink

    Cast an UInt to a SInt

    Cast an UInt to a SInt

    returns

    a SInt data

    Example:
    1. mySInt := myUInt.asSInt
  70. def assignDontCare(): UInt.this.type

    Permalink
    Definition Classes
    UIntData
  71. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    UIntData
  72. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  73. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    UIntData
  74. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    UIntData
  75. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data
  76. def assignMask(maskedLiteral: MaskedLiteral): Unit

    Permalink

    Assign a mask to the output signal

    Assign a mask to the output signal

    maskedLiteral

    masked literal value

    Example:
    1. output4 assignMask M"1111
  77. def bitsRange: Range

    Permalink
    Definition Classes
    BitVector
  78. def ceil(n: Int, align: Boolean = true): UInt

    Permalink

    UInt ceil ceil(x) return if(align) w(this)-n bits else w(this)-n+1 bits

    UInt ceil ceil(x) return if(align) w(this)-n bits else w(this)-n+1 bits

    Definition Classes
    UIntNum
  79. def ceil(width: BitCount, align: Boolean): UInt

    Permalink

    lowest n bits Round Operation by BitCount

    lowest n bits Round Operation by BitCount

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

    Permalink
    Definition Classes
    UIntNum
  81. def ceilToInf(width: BitCount, align: Boolean): UInt

    Permalink
    Definition Classes
    Num
  82. def cldCount: Int

    Permalink
    Definition Classes
    DoubleLinkedContainer
  83. def clearAll(): UInt.this.type

    Permalink

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector
  84. var clockDomain: ClockDomain

    Permalink
    Definition Classes
    BaseType
  85. def clone(): UInt.this.type

    Permalink
    Definition Classes
    BitVectorBaseTypeData → AnyRef
  86. def component: Component

    Permalink
    Definition Classes
    ContextUser
  87. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Permalink
    Definition Classes
    Assignable
  88. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  89. def copyDirectionOf(that: UInt): Unit

    Permalink
    Definition Classes
    DataPrimitives
  90. def copyDirectionOfImpl(that: Data): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  91. def default(that: ⇒ UInt): UInt

    Permalink

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  92. def dirString(): String

    Permalink
    Definition Classes
    Data
  93. def dlcAppend(that: AssignmentStatement): UInt.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  94. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

    Permalink
    Definition Classes
    DoubleLinkedContainer
  95. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  96. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  97. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  98. var dlcLast: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  99. def dlcPrepend(that: AssignmentStatement): UInt.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  100. def dontSimplifyIt(): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  101. def drop(n: Int): Bits

    Permalink

    Drop lowerst n bits

    Drop lowerst n bits

    returns

    data10bits(9 downto 4)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.drop(4)
  102. def dropHigh(n: Int): Bits

    Permalink

    Drop highest n bits

    Drop highest n bits

    returns

    data10bits(5 downto 0)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.dropHigh(4)
  103. def dropLow(n: Int): Bits

    Permalink
    Definition Classes
    BitVector
  104. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  105. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  106. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  107. def expand: UInt

    Permalink
  108. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  109. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  110. def fixTo(q: QFormat): UInt

    Permalink
  111. def fixTo(q: QFormat, roundType: RoundType): UInt

    Permalink
  112. def fixTo(section: Inclusive): UInt

    Permalink
  113. def fixTo(section: Inclusive, roundType: RoundType): UInt

    Permalink
  114. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    BaseTypeData
  115. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeData
  116. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    BaseTypeData
  117. def flip(): UInt.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  118. def floor(n: Int): UInt

    Permalink

    UInt ceil floor(x) return w(this)-n bits

    UInt ceil floor(x) return w(this)-n bits

    Definition Classes
    UIntNum
  119. def floor(width: BitCount): UInt

    Permalink
    Definition Classes
    Num
  120. def floorToZero(n: Int): UInt

    Permalink
    Definition Classes
    UIntNum
  121. def floorToZero(width: BitCount): UInt

    Permalink
    Definition Classes
    Num
  122. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  123. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  124. def foreachExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
  125. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  126. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

    Permalink
  127. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  128. def freeze(): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  129. def genIf(cond: Boolean): UInt.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  130. def getAheadValue(): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  131. def getAllTrue: UInt.this.type

    Permalink
    Definition Classes
    UIntBitVector
  132. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVectorData
  133. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  134. def getComponent(): Component

    Permalink
    Definition Classes
    DataInComponentNameableByComponent
  135. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  136. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  137. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  138. def getDrivingReg: UInt.this.type

    Permalink
    Definition Classes
    BaseType
  139. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  140. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  141. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  142. def getName(): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  143. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  144. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  145. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  146. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  147. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  148. def getRtlPath(separator: String = "/"): String

    Permalink
    Definition Classes
    Data
  149. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  150. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  151. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  152. def getSingleDriver: Option[UInt.this.type]

    Permalink
    Definition Classes
    BaseType
  153. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  154. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  155. def getTypeObject: TypeUInt.type

    Permalink
    Definition Classes
    UIntExpression
  156. def getWidth: Int

    Permalink
    Definition Classes
    WidthableWidthProvider
  157. def getWidthNoInferation: Int

    Permalink

    Return the width

    Return the width

    Definition Classes
    BitVector
  158. def getWidthStringNoInferation: String

    Permalink
    Definition Classes
    BitVector
  159. def getZero: UInt.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    UIntData
  160. def getZeroUnconstrained: UInt.this.type

    Permalink
    Definition Classes
    UIntBitVector
  161. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  162. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  163. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  164. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  165. def hasOnlyOneStatement: Boolean

    Permalink
  166. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  167. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  168. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  169. def head: AssignmentStatement

    Permalink
  170. def high: Int

    Permalink

    Return the upper bound

    Return the upper bound

    Definition Classes
    BitVector
  171. def init(that: UInt): UInt

    Permalink

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  172. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  173. def initial(that: UInt): UInt

    Permalink
    Definition Classes
    BaseTypePrimitives
  174. def initialFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    BaseType
  175. def insertNext(s: Statement): Unit

    Permalink
    Definition Classes
    Statement
  176. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  177. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  178. def intoSInt: SInt

    Permalink
  179. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  180. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  181. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  182. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  183. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  184. def isFrozen(): Boolean

    Permalink
    Definition Classes
    BaseType
  185. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  186. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  187. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  189. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  190. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  191. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  192. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  193. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  194. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  195. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  196. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  197. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  198. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  199. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  200. def lsb: Bool

    Permalink

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  201. def max(right: UInt): UInt

    Permalink

    Return the maximum value between this and right

    Return the maximum value between this and right

    Definition Classes
    Num
  202. def maxValue: BigInt

    Permalink
    Definition Classes
    UIntMinMaxProvider
  203. def min(right: UInt): UInt

    Permalink

    Return the minimum value between this and right

    Return the minimum value between this and right

    Definition Classes
    Num
  204. def minValue: BigInt

    Permalink
    Definition Classes
    UIntMinMaxProvider
  205. def msb: Bool

    Permalink

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  206. def mux[T2 <: Data](mappings: (Any, T2)*): T2

    Permalink
    Definition Classes
    BaseType
  207. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  208. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  209. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  210. var name: String

    Permalink
    Definition Classes
    Nameable
  211. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  212. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  213. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): UInt.this.type

    Permalink

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Permalink

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  217. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  218. def noBackendCombMerge: UInt.this.type

    Permalink
    Definition Classes
    Data
  219. def noCombLoopCheck: UInt.this.type

    Permalink
    Definition Classes
    Data
  220. def normalizeInputs: Unit

    Permalink
    Definition Classes
    BaseTypeExpressionContainer
  221. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  222. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  223. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  224. def opName: String

    Permalink
    Definition Classes
    UIntExpression
  225. def orMask(that: Bool): UInt.this.type

    Permalink
    Definition Classes
    BitVector
  226. def orR: Bool

    Permalink

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  227. def overrideLocalName(name: String): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  228. var parent: Data

    Permalink
    Definition Classes
    Data
  229. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  230. def pull(propagateName: Boolean): UInt.this.type

    Permalink
    Definition Classes
    Data
  231. def pull(): UInt.this.type

    Permalink

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

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

    Definition Classes
    Data
  232. def purify(): UInt.this.type

    Permalink
    Definition Classes
    Data
  233. def randBoot(u: Unit): UInt.this.type

    Permalink

    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
  234. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  235. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  236. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  237. def remapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
  238. def removeAssignments(): UInt.this.type

    Permalink

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseTypeData
  239. def removeStatement(): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  240. def removeStatementFromScope(): Unit

    Permalink
    Definition Classes
    Statement
  241. def removeTag(spinalTag: SpinalTag): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  242. def removeTags(tags: Iterable[SpinalTag]): UInt.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  243. def resize(width: BitCount): UInt.this.type

    Permalink
    Definition Classes
    UIntBitVector
  244. def resize(width: Int): UInt.this.type

    Permalink

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Definition Classes
    UIntBitVector
    Example:
    1. val res = myBits.resize(10)
  245. def resized: UInt.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  246. def reversed: UInt

    Permalink
  247. def rootScopeStatement: ScopeStatement

    Permalink
    Definition Classes
    BaseTypeStatement
  248. def rotateLeft(that: Int): UInt

    Permalink

    Left rotation of that bits

    Left rotation of that bits

    Definition Classes
    UIntBitVector
  249. def rotateLeft(that: UInt): T

    Permalink

    Left rotation of that Bits

    Left rotation of that Bits

    Definition Classes
    BitVector
  250. def rotateRight(that: Int): UInt

    Permalink

    Right rotation of that bits

    Right rotation of that bits

    Definition Classes
    UIntBitVector
  251. def rotateRight(that: UInt): T

    Permalink

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  252. def round(n: Int, align: Boolean = true): UInt

    Permalink
    Definition Classes
    UIntNum
  253. def round(width: BitCount, align: Boolean): UInt

    Permalink
    Definition Classes
    Num
  254. def roundDown(n: Int, align: Boolean): UInt

    Permalink

    UInt roundDown ceil(x - 0.5) return w(this)-n bits

    UInt roundDown ceil(x - 0.5) return w(this)-n bits

    Definition Classes
    UIntNum
  255. def roundDown(width: BitCount, align: Boolean): UInt

    Permalink
    Definition Classes
    Num
  256. def roundToInf(n: Int, align: Boolean = true): UInt

    Permalink
    Definition Classes
    UIntNum
  257. def roundToInf(width: BitCount, align: Boolean): UInt

    Permalink
    Definition Classes
    Num
  258. def roundToZero(n: Int, align: Boolean = true): UInt

    Permalink
    Definition Classes
    UIntNum
  259. def roundToZero(width: BitCount, align: Boolean): UInt

    Permalink
    Definition Classes
    Num
  260. def roundUp(n: Int, align: Boolean = true): UInt

    Permalink

    UInt roundUp floor(x + 0.5) return if(align) w(this)-n bits else w(this)-n+1 bits

    UInt roundUp floor(x + 0.5) return if(align) w(this)-n bits else w(this)-n+1 bits

    Definition Classes
    UIntNum
  261. def roundUp(width: BitCount, align: Boolean): UInt

    Permalink
    Definition Classes
    Num
  262. def sat(m: Int): UInt

    Permalink

    highest m bits Saturation

    highest m bits Saturation

    Definition Classes
    UIntNum
  263. def sat(width: BitCount): UInt

    Permalink
    Definition Classes
    Num
  264. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  265. def setAll(): UInt.this.type

    Permalink

    Set all bits

    Set all bits

    Definition Classes
    UIntBitVector
  266. def setAllTo(value: Bool): UInt.this.type

    Permalink

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  267. def setAllTo(value: Boolean): UInt.this.type

    Permalink

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  268. def setAsAnalog(): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  269. def setAsComb(): UInt.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  270. def setAsDirectionLess(): UInt.this.type

    Permalink

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

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

    Definition Classes
    BaseTypeData
  271. def setAsReg(): UInt.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseTypeData
  272. def setAsTypeNode(): UInt.this.type

    Permalink

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  273. def setAsVital(): UInt.this.type

    Permalink

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  274. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  275. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  276. def setCompositeName(nameable: Nameable, postfix: String): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  277. def setCompositeName(nameable: Nameable, namePriority: Byte): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  278. def setCompositeName(nameable: Nameable, weak: Boolean): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  279. def setCompositeName(nameable: Nameable): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  280. def setName(name: String, namePriority: Byte): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  281. def setName(name: String, weak: Boolean): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  282. def setName(name: String): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  283. def setNameAsWeak(): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  284. def setPartialName(name: String, namePriority: Byte, owner: Any): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  285. def setPartialName(name: String, namePriority: Byte): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  286. def setPartialName(name: String, weak: Boolean): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  287. def setPartialName(owner: Nameable, name: String, namePriority: Byte): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  288. def setPartialName(owner: Nameable, name: String, weak: Boolean): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  289. def setPartialName(name: String): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  290. def setPartialName(owner: Nameable, name: String): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  291. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  292. def setScalaLocated(source: ScalaLocated): UInt.this.type

    Permalink
    Definition Classes
    ScalaLocated
  293. def setWeakName(name: String): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  294. def setWidth(width: Int): UInt.this.type

    Permalink

    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
  295. def simplifyNode: Expression

    Permalink
    Definition Classes
    Expression
  296. def sliceBy(divisor: List[Int]): List[Bits]

    Permalink
    Definition Classes
    BitVector
  297. def sliceBy(divisor: Int*): List[Bits]

    Permalink

    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))
  298. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  299. def splitAt(n: Int): (Bits, Bits)

    Permalink

    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)
  300. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

    Permalink
    Definition Classes
    ExpressionContainer
  301. def subdivideIn(sliceWidth: BitCount): Vec[T]

    Permalink
    Definition Classes
    BitVector
  302. def subdivideIn(sliceCount: SlicesCount): Vec[T]

    Permalink
    Definition Classes
    BitVector
  303. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

    Permalink

    Split the BitVector into slice of x bits * @example

    Split the BitVector into slice of x bits * @example

    val res = myBits.subdiviedIn(3 bits)
    sliceWidth

    the width of the slice

    returns

    a Vector of slices

    Definition Classes
    BitVector
  304. def subdivideIn(sliceCount: SlicesCount, strict: Boolean): Vec[T]

    Permalink

    Split the BitVector into x slice

    Split the BitVector into x slice

    sliceCount

    the width of the slice

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example:
    1. val res = myBits.subdiviedIn(3 slices)
  305. def swichAssign[T2 <: BaseType](sel: T2)(mappings: (Any, UInt)*): Unit

    Permalink
    Definition Classes
    DataPrimitives
  306. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  307. def tag(q: QFormat): UInt

    Permalink
    Definition Classes
    UIntNum
  308. def take(n: Int): Bits

    Permalink

    Take lowerst n bits

    Take lowerst n bits

    returns

    data10bits(3 downto 0)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.take(4)
  309. def takeHigh(n: Int): Bits

    Permalink

    Take highest n bits

    Take highest n bits

    returns

    data10bits(9 downto 6)

    Definition Classes
    BitVector
    Example:
    1. val res = data10bits.takeHigh(4)
  310. def takeLow(n: Int): Bits

    Permalink
    Definition Classes
    BitVector
  311. def toIo(): UInt.this.type

    Permalink
    Definition Classes
    Data
  312. def toString(): String

    Permalink
    Definition Classes
    BitVectorBaseTypeExpressionNameable → AnyRef → Any
  313. def toStringMultiLine(): String

    Permalink
    Definition Classes
    BaseNode
  314. def toStringRec(level: Int = 1): String

    Permalink
    Definition Classes
    Expression
  315. def trim(m: Int): UInt

    Permalink

    highest m bits Discard

    highest m bits Discard

    Definition Classes
    UIntNum
  316. def trim(width: BitCount): UInt

    Permalink
    Definition Classes
    Num
  317. def twoComplement(enable: Bool): SInt

    Permalink

    2'Complement

    2'Complement

    enable

    enable the 2'complement

    returns

    Return the 2'Complement of the number

  318. def unary_~: UInt

    Permalink

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    UIntBitwiseOp
  319. def unfreeze(): UInt.this.type

    Permalink
    Definition Classes
    BaseTypeData
  320. def unsetName(): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  321. def valueRange: Range

    Permalink
  322. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  324. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  325. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  326. def walkExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  327. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  328. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  329. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  330. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  331. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  332. def wrap: AnyRef { ... /* 4 definitions in type refinement */ }

    Permalink
  333. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Permalink
    Definition Classes
    BaseType
  334. def wrapNext(): UInt.this.type

    Permalink
    Definition Classes
    Data
  335. def xorR: Bool

    Permalink

    Logical XOR of all bits

    Logical XOR of all bits

    Definition Classes
    BitVector
  336. def |(right: UInt): UInt

    Permalink

    Logical OR operator

    Logical OR operator

    Definition Classes
    UIntBitwiseOp
  337. def |<<(that: UInt): UInt

    Permalink

    Logical shift left (output width == input width)

  338. def |<<(that: Int): UInt

    Permalink

    Logical shift left (output width == input width)

  339. def |>>(that: UInt): UInt

    Permalink

    Logical shift Right (output width == input width)

  340. def |>>(that: Int): UInt

    Permalink

    Logical shift right (output width = input width)

    Logical shift right (output width = input width)

    that

    the number of shift

    returns

    a Bits of width : w(this)

    Example:
    1. val result = myUInt |>> 4

Deprecated Value Members

  1. def asDirectionLess(): UInt.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  3. def range: Range

    Permalink

    Return the range

    Return the range

    Definition Classes
    BitVector
    Annotations
    @deprecated
    Deprecated

    Use bitsRange instead

Inherited from BitwiseOp[UInt]

Inherited from BaseTypePrimitives[UInt]

Inherited from DataPrimitives[UInt]

Inherited from MinMaxProvider

Inherited from Num[UInt]

Inherited from BitVector

Inherited from Widthable

Inherited from WidthProvider

Inherited from BaseType

Inherited from Expression

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