Class

spinal.core

UInt

Related Doc: package core

Permalink

class UInt extends BitVector with Num[UInt] with MinMaxProvider with DataPrimitives[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. DataPrimitives
  4. MinMaxProvider
  5. Num
  6. BitVector
  7. Widthable
  8. WidthProvider
  9. BaseType
  10. Expression
  11. StatementDoubleLinkedContainer
  12. DoubleLinkedContainer
  13. DeclarationStatement
  14. LeafStatement
  15. Statement
  16. BaseNode
  17. ExpressionContainer
  18. Data
  19. OverridedEqualsHashCode
  20. SpinalTagReady
  21. Assignable
  22. NameableByComponent
  23. Nameable
  24. OwnableRef
  25. ContextUser
  26. ScalaLocated
  27. GlobalDataUser
  28. AnyRef
  29. 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 \(that: UInt): UInt

    Permalink

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

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

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

    Permalink

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    UIntBitwiseOp
  35. def _data: UInt

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

    Permalink
    Attributes
    protected
  37. var _spinalTags: Set[SpinalTag]

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  43. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  44. var algoInt: Int

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

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

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

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

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

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

    Permalink
    Definition Classes
    Data
  50. def andR: Bool

    Permalink

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  51. 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)
  52. 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)
  53. 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)
  54. 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)
  55. 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)
  56. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  57. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    UIntData
  58. def asBool: Bool

    Permalink
    Definition Classes
    BitVector
  59. 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
  60. def asData: Data

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

    Permalink

    set a data as inout

    set a data as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  65. 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
  66. def assignDontCare(): UInt.this.type

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

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

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

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

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

    Permalink

    Assign a mask to the output signal

    Assign a mask to the output signal

    maskedLiteral

    masked litteral value

    Example:
    1. output4 assignMask M"1111
  72. 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
  73. 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
  74. def ceilToInf(n: Int, align: Boolean = true): UInt

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

    Permalink
    Definition Classes
    Num
  76. def clearAll(): UInt.this.type

    Permalink

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector
  77. var clockDomain: ClockDomain

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

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

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

    Permalink
    Definition Classes
    Assignable
  81. var compositeAssign: Assignable

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

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

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

    Permalink

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  85. def dirString(): String

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

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

    Permalink
    Definition Classes
    DoubleLinkedContainer
  88. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  89. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  90. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  91. var dlcLast: AssignmentStatement

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

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

    Permalink
    Definition Classes
    BaseTypeData
  94. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  97. def expand: UInt

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  100. def fixTo(section: Inclusive, roundType: RoundType = RoundType.ROUNDTOINF): UInt

    Permalink

    Factory fixTo Function

  101. def flatten: Seq[BaseType]

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

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

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

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  105. 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
  106. def floor(width: BitCount): UInt

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  115. def genIf(cond: Boolean): UInt.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  116. def getAllTrue: UInt.this.type

    Permalink
    Definition Classes
    UIntBitVector
  117. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

    Permalink
    Definition Classes
    DataNameableByComponent
  120. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  121. def getDirection: IODirection

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

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

    Permalink
    Definition Classes
    BaseType
  124. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  125. def getMode: Byte

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

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

    Permalink
    Definition Classes
    Nameable
  128. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  129. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  130. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  132. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  133. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  134. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  138. def getTags(): Set[SpinalTag]

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

    Permalink
    Definition Classes
    UIntExpression
  140. def getWidth: Int

    Permalink
    Definition Classes
    WidthableWidthProvider
  141. def getWidthNoInferation: Int

    Permalink

    Return the width

    Return the width

    Definition Classes
    BitVector
  142. def getWidthStringNoInferation: String

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

    Permalink

    Create a data set to 0

    Create a data set to 0

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

    Permalink
    Definition Classes
    UIntBitVector
  145. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  146. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  147. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  148. def hasOnlyOneStatement: Boolean

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

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

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

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

    Permalink
  153. def high: Int

    Permalink

    Return the upper bound

    Return the upper bound

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

    Permalink

    Set inital value to a data

    Set inital value to a data

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

    Permalink
    Definition Classes
    Data
  156. def insertNext(s: Statement): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  159. def intoSInt: SInt

    Permalink
  160. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  161. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  162. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  163. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  164. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  165. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  166. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  168. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  169. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  170. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  172. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  173. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  174. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  175. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  176. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  177. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  178. def keep(): UInt.this.type

    Permalink
    Definition Classes
    Data
  179. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  180. def lsb: Bool

    Permalink

    Return the least significant bit

    Return the least significant bit

    Definition Classes
    BitVector
  181. 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
  182. def maxValue: BigInt

    Permalink
    Definition Classes
    UIntMinMaxProvider
  183. 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
  184. def minValue: BigInt

    Permalink
    Definition Classes
    UIntMinMaxProvider
  185. def msb: Bool

    Permalink

    Return the most significant bit

    Return the most significant bit

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

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

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

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

    Permalink
    Definition Classes
    BaseType
  190. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  191. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  193. 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
  194. 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
  195. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Permalink

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Permalink

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  197. var nextScopeStatement: Statement

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

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

    Permalink
    Definition Classes
    Data
  200. def normalizeInputs: Unit

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  204. def opName: String

    Permalink
    Definition Classes
    UIntExpression
  205. def orR: Bool

    Permalink

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  206. var parent: Data

    Permalink
    Definition Classes
    Data
  207. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  208. 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
  209. def purify(): UInt.this.type

    Permalink
    Definition Classes
    Data
  210. def randBoot(): UInt.this.type

    Permalink

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

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

    Definition Classes
    Data
  211. def range: Range

    Permalink

    Return the range

    Return the range

    Definition Classes
    BitVector
  212. var refOwner: RefOwnerType

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

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

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

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

    Permalink

    Remove all assignements of the base type

    Remove all assignements of the base type

    Definition Classes
    BaseTypeData
  217. def removeStatement(): Unit

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  221. def resize(width: BitCount): UInt

    Permalink
    Definition Classes
    UIntBitVector
  222. 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)
  223. def resized: UInt.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  224. def rootScopeStatement: ScopeStatement

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

    Permalink

    Left rotation of that bits

    Left rotation of that bits

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

    Permalink

    Left rotation of that Bits

    Left rotation of that Bits

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

    Permalink

    Right rotation of that bits

    Right rotation of that bits

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

    Permalink

    Right rotation of that Bits

    Right rotation of that Bits

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

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

    Permalink
    Definition Classes
    Num
  231. 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
  232. def roundDown(width: BitCount, align: Boolean): UInt

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

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

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

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

    Permalink
    Definition Classes
    Num
  237. 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
  238. def roundUp(width: BitCount, align: Boolean): UInt

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

    Permalink

    highest m bits Saturation

    highest m bits Saturation

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

    Permalink
    Definition Classes
    Num
  241. def setAll(): UInt.this.type

    Permalink

    Set all bits

    Set all bits

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

    Permalink

    Set all bits to value

    Set all bits to value

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

    Permalink

    Set all bits to value

    Set all bits to value

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  246. 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
  247. def setAsReg(): UInt.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

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

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  268. 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
  269. def simplifyNode: Expression

    Permalink
    Definition Classes
    Expression
  270. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  271. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

    Permalink
    Definition Classes
    ExpressionContainer
  272. def subdivideIn(sliceWidth: BitCount): 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
  273. def subdivideIn(sliceCount: SlicesCount): 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)
  274. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  275. def toString(): String

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

    Permalink
    Definition Classes
    BaseNode
  277. def trim(m: Int): UInt

    Permalink

    highest m bits Discard

    highest m bits Discard

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

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

    Permalink

    2'Complement

    2'Complement

    enable

    enable the 2'complement

    returns

    Return the 2'Complement of the number

  280. def unary_~: UInt

    Permalink

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    UIntBitwiseOp
  281. def unsetName(): UInt.this.type

    Permalink
    Definition Classes
    Nameable
  282. final def wait(arg0: Long, arg1: Int): Unit

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ExpressionContainer
  291. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Permalink
    Definition Classes
    BaseType
  292. def xorR: Bool

    Permalink

    Logical XOR of all bits

    Logical XOR of all bits

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

    Permalink

    Logical OR operator

    Logical OR operator

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

    Permalink

    Logical shift left (output width == input width)

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

    Permalink

    Logical shift left (output width == input width)

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

    Permalink

    Logical shift Right (output width == input width)

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

Inherited from BitwiseOp[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 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