Packages

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
BitwiseOp[UInt], BaseTypePrimitives[UInt], DataPrimitives[UInt], MinMaxProvider, Num[UInt], 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. 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. Protected

Instance Constructors

  1. new UInt()

Type Members

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

    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
    UInt → 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 %(right: UInt): UInt

    Modulo

    Modulo

    Definition Classes
    UInt → Num
  5. def &(right: UInt): UInt

    Logical AND operator

    Logical AND operator

    Definition Classes
    UInt → BitwiseOp
  6. def *(right: UInt): UInt

    Multiplication

    Multiplication

    Definition Classes
    UInt → Num
  7. def +(right: UInt): UInt

    Addition

    Addition

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

    Safe Addition with 1 bit expand

    Safe Addition with 1 bit expand

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

    Safe Addition with saturation

    Safe Addition with saturation

    Definition Classes
    UInt → Num
  10. def -(right: UInt): UInt

    Substraction

    Substraction

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

    Safe Substraction with 1 bit expand

    Safe Substraction with 1 bit expand

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

    Safe Substraction with saturation

    Safe Substraction with saturation

    Definition Classes
    UInt → Num
  13. def /(right: UInt): UInt

    Division

    Division

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

    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

    Assign a data to this

    Assign a data to this

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

    Is less than right

    Is less than right

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

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

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

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

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

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

    Is equal or less than right

    Is equal or less than right

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

    Auto connection between two data

    Auto connection between two data

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

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

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

    Comparison between two data

    Comparison between two data

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

    Is greater than right

    Is greater than right

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

    Is equal or greater than right

    Is equal or greater than right

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

    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

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

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

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

    Concatenation between a UInt and a Bool

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

    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
    Definition Classes
    Num
  34. def \(that: UInt): UInt

    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

    Logical XOR operator

    Logical XOR operator

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

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  49. def allowPartialyAssigned: UInt.this.type
    Definition Classes
    Data
  50. def allowPruning(): UInt.this.type
    Definition Classes
    Data
  51. def allowSimplifyIt(): UInt.this.type
    Definition Classes
    BaseType → Data
  52. def allowUnsetRegToAvoidLatch: UInt.this.type
    Definition Classes
    Data
  53. def andMask(that: Bool): UInt.this.type
    Definition Classes
    BitVector
  54. def andR: Bool

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  55. def apply(offset: UInt, bitCount: BitCount): UInt.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
    UInt → BitVector
    Example:

    1. val myBool = myBits(myUInt, 2 bits)
  56. def apply(offset: Int, bitCount: BitCount): UInt.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
    UInt → BitVector
    Example:

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

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UInt → BitVector
    Example:

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

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UInt → BitVector
    Example:

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

    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
    Definition Classes
    Data
  61. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    UInt → Data
  62. def asBool: Bool
    Definition Classes
    BitVector
  63. 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
  64. def asData: Data
    Definition Classes
    Data
  65. def asInOut(): UInt.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseType → Data
  66. def asInput(): UInt.this.type

    Set a data as input

    Set a data as input

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

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  69. def asSInt: SInt

    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
    Definition Classes
    UInt → Data
  71. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  72. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    UInt → Data
  73. def assignFromBits(bits: Bits): Unit
    Definition Classes
    UInt → Data
  74. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  75. def assignMask(maskedLiteral: MaskedLiteral): Unit

    Assign a mask to the output signal

    Assign a mask to the output signal

    maskedLiteral

    masked literal value

    Example:

    1. output4 assignMask M"1111
  76. def bitsRange: Range
    Definition Classes
    BitVector
  77. def ceil(n: Int, align: Boolean = true): UInt

    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
    UInt → Num
  78. def ceil(width: BitCount, align: Boolean): UInt

    lowest n bits Round Operation by BitCount

    lowest n bits Round Operation by BitCount

    Definition Classes
    Num
  79. def ceilToInf(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  80. def ceilToInf(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  81. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  82. def clearAll(): UInt.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector
  83. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  84. def clone(): UInt.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  85. def component: Component
    Definition Classes
    ContextUser
  86. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  87. val compositeAssign: Assignable
    Definition Classes
    Assignable
  88. def copyDirectionOf(that: UInt): Unit
    Definition Classes
    DataPrimitives
  89. def copyDirectionOfImpl(that: Data): UInt.this.type
    Definition Classes
    BaseType → Data
  90. def default(that: => UInt): UInt

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  91. def dirString(): String
    Definition Classes
    Data
  92. def dlcAppend(that: AssignmentStatement): UInt.this.type
    Definition Classes
    DoubleLinkedContainer
  93. def dlcForeach[T >: AssignmentStatement](func: (T) => Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  94. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  95. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  96. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  97. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  98. def dlcPrepend(that: AssignmentStatement): UInt.this.type
    Definition Classes
    DoubleLinkedContainer
  99. def dontSimplifyIt(): UInt.this.type
    Definition Classes
    BaseType → Data
  100. 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)
  101. 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)
  102. def dropLow(n: Int): Bits
    Definition Classes
    BitVector
  103. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  104. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  105. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  106. def expand: UInt
  107. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  108. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  109. def fixTo(q: QFormat): UInt
  110. def fixTo(q: QFormat, roundType: RoundType): UInt
  111. def fixTo(section: Inclusive): UInt
  112. def fixTo(section: Inclusive, roundType: RoundType): UInt
  113. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  114. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    BaseType → Data
  115. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  116. def flip(): UInt.this.type

    flip the direction of the data

    flip the direction of the data

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

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

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

    Definition Classes
    UInt → Num
  118. def floor(width: BitCount): UInt
    Definition Classes
    Num
  119. def floorToZero(n: Int): UInt
    Definition Classes
    UInt → Num
  120. def floorToZero(width: BitCount): UInt
    Definition Classes
    Num
  121. def foreachClockDomain(func: (ClockDomain) => Unit): Unit
    Definition Classes
    BaseType → Statement
  122. def foreachDrivingExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  123. def foreachExpression(func: (Expression) => Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  124. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  125. def foreachStatements(func: (AssignmentStatement) => Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  126. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  127. def freeze(): UInt.this.type
    Definition Classes
    BaseType → Data
  128. def genIf(cond: Boolean): UInt.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  129. def getAllTrue: UInt.this.type
    Definition Classes
    UInt → BitVector
  130. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  134. def getDirection: IODirection
    Definition Classes
    Data
  135. def getDisplayName(): String
    Definition Classes
    Nameable
  136. def getDrivingReg: UInt.this.type
    Definition Classes
    BaseType
  137. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  138. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  139. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  140. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  141. def getPartialName(): String
    Definition Classes
    Nameable
  142. def getRealSource: Any
    Definition Classes
    Assignable
  143. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  144. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  145. def getRootParent: Data
    Definition Classes
    Data
  146. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  147. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  148. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  149. def getSingleDriver: Option[UInt.this.type]
    Definition Classes
    BaseType
  150. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  151. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  152. def getTypeObject: TypeUInt
    Definition Classes
    UInt → Expression
  153. def getWidth: Int
    Definition Classes
    Widthable → WidthProvider
  154. def getWidthNoInferation: Int

    Return the width

    Return the width

    Definition Classes
    BitVector
  155. def getWidthStringNoInferation: String
    Definition Classes
    BitVector
  156. def getZero: UInt.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    UInt → Data
  157. def getZeroUnconstrained: UInt.this.type
    Definition Classes
    UInt → BitVector
  158. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  159. def hasAssignement: Boolean
    Definition Classes
    BaseType
  160. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  161. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  162. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  163. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  164. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  165. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  166. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  167. def high: Int

    Return the upper bound

    Return the upper bound

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

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  169. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  170. def initial(that: UInt): UInt
    Definition Classes
    BaseTypePrimitives
  171. def initialFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    BaseType
  172. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  173. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  174. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  175. def intoSInt: SInt
  176. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  177. def isComb: Boolean
    Definition Classes
    BaseType → Data
  178. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  179. def isDirectionLess: Boolean
    Definition Classes
    Data
  180. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  181. def isFrozen(): Boolean
    Definition Classes
    BaseType
  182. def isInOut: Boolean
    Definition Classes
    Data
  183. def isInput: Boolean
    Definition Classes
    Data
  184. def isInputOrInOut: Boolean
    Definition Classes
    Data
  185. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  186. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  187. def isOutput: Boolean
    Definition Classes
    Data
  188. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  189. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  190. def isReg: Boolean
    Definition Classes
    BaseType → Data
  191. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  192. def isUnnamed: Boolean
    Definition Classes
    Nameable
  193. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  194. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  195. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  196. def keep(): UInt.this.type
    Definition Classes
    Data
  197. val lastScopeStatement: Statement
    Definition Classes
    Statement
  198. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

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

    Return the maximum value between this and right

    Return the maximum value between this and right

    Definition Classes
    Num
  200. def maxValue: BigInt
    Definition Classes
    UInt → MinMaxProvider
  201. def min(right: UInt): UInt

    Return the minimum value between this and right

    Return the minimum value between this and right

    Definition Classes
    Num
  202. def minValue: BigInt
    Definition Classes
    UInt → MinMaxProvider
  203. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  204. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  205. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  206. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  207. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  208. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  209. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  210. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  211. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): UInt.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

    Definition Classes
    BitVector
  212. def newExtract(hi: Int, lo: Int, accessFactory: => BitVectorRangedAccessFixed): UInt.this.type

    Extract a range of bits of the BitVector

    Extract a range of bits of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  215. val nextScopeStatement: Statement
    Definition Classes
    Statement
  216. def noBackendCombMerge: UInt.this.type
    Definition Classes
    Data
  217. def noCombLoopCheck: UInt.this.type
    Definition Classes
    Data
  218. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  219. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  220. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  221. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  222. def opName: String
    Definition Classes
    UInt → Expression
  223. def orMask(that: Bool): UInt.this.type
    Definition Classes
    BitVector
  224. def orR: Bool

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  225. def overrideLocalName(name: String): UInt.this.type
    Definition Classes
    Nameable
  226. val parent: Data
    Definition Classes
    Data
  227. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  228. def pull(): UInt.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
  229. def purify(): UInt.this.type
    Definition Classes
    Data
  230. def randBoot(u: Unit): UInt.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
  231. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  232. def reflectNames(): Unit
    Definition Classes
    Nameable
  233. def remapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  234. def remapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  235. def removeAssignments(): UInt.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  236. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  237. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  238. def removeTag(spinalTag: SpinalTag): UInt.this.type
    Definition Classes
    SpinalTagReady
  239. def removeTags(tags: Iterable[SpinalTag]): UInt.this.type
    Definition Classes
    SpinalTagReady
  240. def resize(width: BitCount): UInt
    Definition Classes
    UInt → BitVector
  241. def resize(width: Int): UInt.this.type

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Definition Classes
    UInt → BitVector
    Example:

    1. val res = myBits.resize(10)
  242. def resized: UInt.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  243. def reversed: UInt
  244. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  245. def rotateLeft(that: Int): UInt

    Left rotation of that bits

    Left rotation of that bits

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

    Left rotation of that Bits

    Left rotation of that Bits

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

    Right rotation of that bits

    Right rotation of that bits

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

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  249. def round(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  250. def round(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  251. def roundDown(n: Int, align: Boolean): UInt

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

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

    Definition Classes
    UInt → Num
  252. def roundDown(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  253. def roundToInf(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  254. def roundToInf(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  255. def roundToZero(n: Int, align: Boolean = true): UInt
    Definition Classes
    UInt → Num
  256. def roundToZero(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  257. def roundUp(n: Int, align: Boolean = true): UInt

    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
    UInt → Num
  258. def roundUp(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  259. def sat(m: Int): UInt

    highest m bits Saturation

    highest m bits Saturation

    Definition Classes
    UInt → Num
  260. def sat(width: BitCount): UInt
    Definition Classes
    Num
  261. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  262. def setAll(): UInt.this.type

    Set all bits

    Set all bits

    Definition Classes
    UInt → BitVector
  263. def setAllTo(value: Bool): UInt.this.type

    Set all bits to value

    Set all bits to value

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

    Set all bits to value

    Set all bits to value

    Definition Classes
    BitVector
  265. def setAsAnalog(): UInt.this.type
    Definition Classes
    BaseType → Data
  266. def setAsComb(): UInt.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  267. def setAsDirectionLess(): UInt.this.type

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

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

    Definition Classes
    BaseType → Data
  268. def setAsReg(): UInt.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType → Data
  269. def setAsTypeNode(): UInt.this.type

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  271. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  272. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  273. def setCompositeName(nameable: Nameable, postfix: String): UInt.this.type
    Definition Classes
    Nameable
  274. def setCompositeName(nameable: Nameable, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  275. def setCompositeName(nameable: Nameable, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  276. def setCompositeName(nameable: Nameable): UInt.this.type
    Definition Classes
    Nameable
  277. def setName(name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  278. def setName(name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  279. def setName(name: String): UInt.this.type
    Definition Classes
    Nameable
  280. def setNameAsWeak(): UInt.this.type
    Definition Classes
    Nameable
  281. def setPartialName(name: String, namePriority: Byte, owner: Any): UInt.this.type
    Definition Classes
    Nameable
  282. def setPartialName(name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  283. def setPartialName(name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  284. def setPartialName(owner: Nameable, name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  285. def setPartialName(owner: Nameable, name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  286. def setPartialName(name: String): UInt.this.type
    Definition Classes
    Nameable
  287. def setPartialName(owner: Nameable, name: String): UInt.this.type
    Definition Classes
    Nameable
  288. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  289. def setScalaLocated(source: ScalaLocated): UInt.this.type
    Definition Classes
    ScalaLocated
  290. def setWeakName(name: String): UInt.this.type
    Definition Classes
    Nameable
  291. def setWidth(width: Int): UInt.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
  292. def simplifyNode: Expression
    Definition Classes
    Expression
  293. def sliceBy(divisor: List[Int]): List[Bits]
    Definition Classes
    BitVector
  294. 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))
  295. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  296. 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)
  297. def stabilized(func: (Expression) => Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  298. def subdivideIn(sliceWidth: BitCount): Vec[T]
    Definition Classes
    BitVector
  299. def subdivideIn(sliceCount: SlicesCount): Vec[T]
    Definition Classes
    BitVector
  300. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

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

    returns

    a Vector of slices

    Definition Classes
    BitVector
    Example:

    1. val res = myBits.subdiviedIn(3 slices)
  302. def swichAssign[T2 <: BaseType](sel: T2)(mappings: (Any, UInt)*): Unit
    Definition Classes
    DataPrimitives
  303. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  304. def tag(q: QFormat): UInt
    Definition Classes
    UInt → Num
  305. 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)
  306. 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)
  307. def takeLow(n: Int): Bits
    Definition Classes
    BitVector
  308. def toIo(): UInt.this.type
    Definition Classes
    Data
  309. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  310. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  311. def trim(m: Int): UInt

    highest m bits Discard

    highest m bits Discard

    Definition Classes
    UInt → Num
  312. def trim(width: BitCount): UInt
    Definition Classes
    Num
  313. def twoComplement(enable: Bool): SInt

    2'Complement

    2'Complement

    enable

    enable the 2'complement

    returns

    Return the 2'Complement of the number

  314. def unary_~: UInt

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    UInt → BitwiseOp
  315. def unfreeze(): UInt.this.type
    Definition Classes
    BaseType → Data
  316. def unsetName(): UInt.this.type
    Definition Classes
    Nameable
  317. def valueRange: Range
  318. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  319. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  320. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  321. def walkDrivingExpressions(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  322. def walkExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  323. def walkExpressionPostorder(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  324. def walkParentTreeStatements(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  325. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  326. def walkRemapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  327. def walkRemapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  328. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  329. def wrapNext(): UInt.this.type
    Definition Classes
    Data
  330. def xorR: Bool

    Logical XOR of all bits

    Logical XOR of all bits

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

    Logical OR operator

    Logical OR operator

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

    Logical shift left (output width == input width)

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

    Logical shift left (output width == input width)

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

    Logical shift Right (output width == input width)

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

    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
    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 range: Range

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