Packages

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

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

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
    UIntBitVector

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
    UIntNum
  5. def &(right: UInt): UInt

    Logical AND operator

    Logical AND operator

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

    Multiplication

    Multiplication

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

    Addition

    Addition

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

    Safe Addition with 1 bit expand

    Safe Addition with 1 bit expand

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

    Safe Addition with saturation

    Safe Addition with saturation

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

    Substraction

    Substraction

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

    Safe Substraction with 1 bit expand

    Safe Substraction with 1 bit expand

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

    Safe Substraction with saturation

    Safe Substraction with saturation

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

    Division

    Division

    Definition Classes
    UIntNum
  14. 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)
  15. def :=(that: UInt): Unit

    Assign a data to this

    Assign a data to this

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

    Is less than right

    Is less than right

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

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

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

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

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

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

    Is equal or less than right

    Is equal or less than right

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

    Auto connection between two data

    Auto connection between two data

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

    BitVector is not equal to MaskedLiteral

    BitVector is not equal to MaskedLiteral

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

    Comparison between two data

    Comparison between two data

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

    Is greater than right

    Is greater than right

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

    Is equal or greater than right

    Is equal or greater than right

    Definition Classes
    UIntNum
  28. 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
  29. def >>(that: Int): UInt

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

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

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

    Concatenation between a UInt and a Bool

  31. 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
  32. def \(that: UInt): UInt

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

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

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

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    UIntBitwiseOp
  34. def _data: UInt
    Definition Classes
    UIntDataPrimitives
  35. def _fixEntry(roundN: Int, roundType: RoundType, satN: Int): UInt
    Attributes
    protected
  36. val _spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  37. def addAttribute(attribute: Attribute): UInt.this.type
    Definition Classes
    BaseTypeDataSpinalTagReady
  38. def addAttribute(name: String, value: String): UInt.this.type
    Definition Classes
    SpinalTagReady
  39. def addAttribute(name: String): UInt.this.type
    Definition Classes
    SpinalTagReady
  40. def addTag[T <: SpinalTag](spinalTag: T): UInt.this.type
    Definition Classes
    SpinalTagReady
  41. def addTags[T <: SpinalTag](tags: Iterable[T]): UInt.this.type
    Definition Classes
    SpinalTagReady
  42. val algoIncrementale: Int
    Definition Classes
    BaseNode
  43. val algoInt: Int
    Definition Classes
    BaseNode
  44. def allowDirectionLessIo: UInt.this.type
    Definition Classes
    Data
  45. def allowOverride: UInt.this.type

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  46. def allowPruning(): UInt.this.type
    Definition Classes
    Data
  47. def allowSimplifyIt(): UInt.this.type
    Definition Classes
    BaseTypeData
  48. def allowUnsetRegToAvoidLatch: UInt.this.type
    Definition Classes
    Data
  49. def andR: Bool

    Logical AND of all bits

    Logical AND of all bits

    Definition Classes
    BitVector
  50. 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
    UIntBitVector
    Example:
    1. val myBool = myBits(myUInt, 2 bits)
  51. 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
    UIntBitVector
    Example:
    1. val myBool = myBits(3, 2 bits)
  52. def apply(bitId: UInt): Bool

    Return the bit at index bitId

    Return the bit at index bitId

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

    Return the bit at index bitId

    Return the bit at index bitId

    Definition Classes
    UIntBitVector
    Example:
    1. val myBool = myBits(3)
  54. 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)
  55. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  56. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    UIntData
  57. def asBool: Bool
    Definition Classes
    BitVector
  58. 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
  59. def asData: Data
    Definition Classes
    Data
  60. def asInOut(): UInt.this.type

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

    Definition Classes
    BaseTypeData
  62. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  63. def asOutput(): UInt.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  64. def asSInt: SInt

    Cast an UInt to a SInt

    Cast an UInt to a SInt

    returns

    a SInt data

    Example:
    1. mySInt := myUInt.asSInt
  65. def assignDontCare(): UInt.this.type
    Definition Classes
    UIntData
  66. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  67. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    UIntData
  68. def assignFromBits(bits: Bits): Unit
    Definition Classes
    UIntData
  69. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  70. def assignMask(maskedLiteral: MaskedLiteral): Unit

    Assign a mask to the output signal

    Assign a mask to the output signal

    maskedLiteral

    masked litteral value

    Example:
    1. output4 assignMask M"1111
  71. 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
    UIntNum
  72. def ceil(width: BitCount, align: Boolean): UInt

    lowest n bits Round Operation by BitCount

    lowest n bits Round Operation by BitCount

    Definition Classes
    Num
  73. def ceilToInf(n: Int, align: Boolean = true): UInt
    Definition Classes
    UIntNum
  74. def ceilToInf(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  75. def clearAll(): UInt.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector
  76. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  77. def clone(): UInt.this.type
    Definition Classes
    BitVectorBaseTypeData → AnyRef
  78. def component: Component
    Definition Classes
    ContextUser
  79. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  80. val compositeAssign: Assignable
    Definition Classes
    Assignable
  81. def copyDirectionOf(that: UInt): Unit
    Definition Classes
    DataPrimitives
  82. def copyDirectionOfImpl(that: Data): UInt.this.type
    Definition Classes
    BaseTypeData
  83. def default(that: ⇒ UInt): UInt

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  84. def dirString(): String
    Definition Classes
    Data
  85. def dlcAppend(that: AssignmentStatement): UInt.this.type
    Definition Classes
    DoubleLinkedContainer
  86. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  87. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  88. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  89. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  90. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  91. def dlcPrepend(that: AssignmentStatement): UInt.this.type
    Definition Classes
    DoubleLinkedContainer
  92. def dontSimplifyIt(): UInt.this.type
    Definition Classes
    BaseTypeData
  93. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  95. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  96. def expand: UInt
  97. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  98. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  99. def fixTo(section: Inclusive, roundType: RoundType = RoundType.ROUNDTOINF): UInt

    Factory fixTo Function

  100. def flatten: Seq[BaseType]
    Definition Classes
    BaseTypeData
  101. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    BaseTypeData
  102. def flattenLocalName: Seq[String]
    Definition Classes
    BaseTypeData
  103. def flip(): UInt.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  104. 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
    UIntNum
  105. def floor(width: BitCount): UInt
    Definition Classes
    Num
  106. def floorToZero(n: Int): UInt
    Definition Classes
    UIntNum
  107. def floorToZero(width: BitCount): UInt
    Definition Classes
    Num
  108. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit
    Definition Classes
    BaseTypeStatement
  109. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  110. def foreachExpression(func: (Expression) ⇒ Unit): Unit
  111. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  112. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit
  113. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  114. def genIf(cond: Boolean): UInt.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  115. def getAllTrue: UInt.this.type
    Definition Classes
    UIntBitVector
  116. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVectorData
  117. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  118. def getComponent(): Component
    Definition Classes
    DataNameableByComponent
  119. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  120. def getDirection: IODirection
    Definition Classes
    Data
  121. def getDisplayName(): String
    Definition Classes
    Nameable
  122. def getDrivingReg: UInt.this.type
    Definition Classes
    BaseType
  123. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  124. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  125. def getName(default: String): String
    Definition Classes
    NameableByComponentNameable
  126. def getName(): String
    Definition Classes
    Nameable
  127. def getPartialName(): String
    Definition Classes
    Nameable
  128. def getRealSource: Any
    Definition Classes
    Assignable
  129. def getRealSourceNoRec: Any
    Definition Classes
    DataAssignable
  130. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  131. def getRootParent: Data
    Definition Classes
    Data
  132. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  133. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  134. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  135. def getSingleDriver: Option[UInt.this.type]
    Definition Classes
    BaseType
  136. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  137. def getTags(): Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  138. def getTypeObject: TypeUInt.type
    Definition Classes
    UIntExpression
  139. def getWidth: Int
    Definition Classes
    WidthableWidthProvider
  140. def getWidthNoInferation: Int

    Return the width

    Return the width

    Definition Classes
    BitVector
  141. def getWidthStringNoInferation: String
    Definition Classes
    BitVector
  142. def getZero: UInt.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    UIntData
  143. def getZeroUnconstrained: UInt.this.type
    Definition Classes
    UIntBitVector
  144. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  145. def hasAssignement: Boolean
    Definition Classes
    BaseType
  146. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  147. def hasOnlyOneStatement: Boolean
  148. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  149. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  150. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  151. def head: AssignmentStatement
  152. def high: Int

    Return the upper bound

    Return the upper bound

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

    Set inital value to a data

    Set inital value to a data

    Definition Classes
    DataPrimitives
  154. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  155. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  156. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  157. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  158. def intoSInt: SInt
  159. def isAnalog: Boolean
    Definition Classes
    BaseTypeData
  160. def isComb: Boolean
    Definition Classes
    BaseTypeData
  161. def isDirectionLess: Boolean
    Definition Classes
    Data
  162. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  163. def isInOut: Boolean
    Definition Classes
    Data
  164. def isInput: Boolean
    Definition Classes
    Data
  165. def isInputOrInOut: Boolean
    Definition Classes
    Data
  166. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  167. def isNamed: Boolean
    Definition Classes
    NameableByComponentNameable
  168. def isOutput: Boolean
    Definition Classes
    Data
  169. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  170. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  171. def isReg: Boolean
    Definition Classes
    BaseTypeData
  172. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  173. def isUnnamed: Boolean
    Definition Classes
    Nameable
  174. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  175. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  176. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  177. def keep(): UInt.this.type
    Definition Classes
    Data
  178. val lastScopeStatement: Statement
    Definition Classes
    Statement
  179. def lsb: Bool

    Return the least significant bit

    Return the least significant bit

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

    Return the maximum value between this and right

    Return the maximum value between this and right

    Definition Classes
    Num
  181. def maxValue: BigInt
    Definition Classes
    UIntMinMaxProvider
  182. def min(right: UInt): UInt

    Return the minimum value between this and right

    Return the minimum value between this and right

    Definition Classes
    Num
  183. def minValue: BigInt
    Definition Classes
    UIntMinMaxProvider
  184. def msb: Bool

    Return the most significant bit

    Return the most significant bit

    Definition Classes
    BitVector
  185. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  186. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  187. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  188. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  189. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  190. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  191. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  192. 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
  193. 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
  194. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Extract a bit of the BitVector

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

    Extract a bit of the BitVector

    Definition Classes
    BitVector
  196. val nextScopeStatement: Statement
    Definition Classes
    Statement
  197. def noBackendCombMerge: UInt.this.type
    Definition Classes
    Data
  198. def noCombLoopCheck: UInt.this.type
    Definition Classes
    Data
  199. def normalizeInputs: Unit
    Definition Classes
    BaseTypeExpressionContainer
  200. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  201. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  202. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  203. def opName: String
    Definition Classes
    UIntExpression
  204. def orR: Bool

    Logical OR of all bits

    Logical OR of all bits

    Definition Classes
    BitVector
  205. val parent: Data
    Definition Classes
    Data
  206. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  207. 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
  208. def purify(): UInt.this.type
    Definition Classes
    Data
  209. def randBoot(): UInt.this.type

    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
  210. def range: Range

    Return the range

    Return the range

    Definition Classes
    BitVector
  211. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  212. def reflectNames(): Unit
    Definition Classes
    Nameable
  213. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  214. def remapExpressions(func: (Expression) ⇒ Expression): Unit
  215. def removeAssignments(): UInt.this.type

    Remove all assignements of the base type

    Remove all assignements of the base type

    Definition Classes
    BaseTypeData
  216. def removeStatement(): Unit
    Definition Classes
    BaseTypeStatement
  217. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  218. def removeTag(spinalTag: SpinalTag): UInt.this.type
    Definition Classes
    SpinalTagReady
  219. def removeTags(tags: Iterable[SpinalTag]): UInt.this.type
    Definition Classes
    SpinalTagReady
  220. def resize(width: BitCount): UInt
    Definition Classes
    UIntBitVector
  221. def resize(width: Int): UInt.this.type

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

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

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  223. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseTypeStatement
  224. def rotateLeft(that: Int): UInt

    Left rotation of that bits

    Left rotation of that bits

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

    Left rotation of that Bits

    Left rotation of that Bits

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

    Right rotation of that bits

    Right rotation of that bits

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

    Right rotation of that Bits

    Right rotation of that Bits

    Definition Classes
    BitVector
  228. def round(n: Int, align: Boolean = true): UInt
    Definition Classes
    UIntNum
  229. def round(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  230. 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
    UIntNum
  231. def roundDown(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  232. def roundToInf(n: Int, align: Boolean = true): UInt
    Definition Classes
    UIntNum
  233. def roundToInf(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  234. def roundToZero(n: Int, align: Boolean = true): UInt
    Definition Classes
    UIntNum
  235. def roundToZero(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  236. 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
    UIntNum
  237. def roundUp(width: BitCount, align: Boolean): UInt
    Definition Classes
    Num
  238. def sat(m: Int): UInt

    highest m bits Saturation

    highest m bits Saturation

    Definition Classes
    UIntNum
  239. def sat(width: BitCount): UInt
    Definition Classes
    Num
  240. def setAll(): UInt.this.type

    Set all bits

    Set all bits

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

    Set all bits to value

    Set all bits to value

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

    Set all bits to value

    Set all bits to value

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Set baseType to reg

    Set baseType to reg

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

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  249. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  250. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  251. def setCompositeName(nameable: Nameable, postfix: String): UInt.this.type
    Definition Classes
    Nameable
  252. def setCompositeName(nameable: Nameable, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  253. def setCompositeName(nameable: Nameable, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  254. def setCompositeName(nameable: Nameable): UInt.this.type
    Definition Classes
    Nameable
  255. def setName(name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  256. def setName(name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  257. def setName(name: String): UInt.this.type
    Definition Classes
    Nameable
  258. def setPartialName(name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  259. def setPartialName(name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  260. def setPartialName(owner: Nameable, name: String, namePriority: Byte): UInt.this.type
    Definition Classes
    Nameable
  261. def setPartialName(owner: Nameable, name: String, weak: Boolean): UInt.this.type
    Definition Classes
    Nameable
  262. def setPartialName(name: String): UInt.this.type
    Definition Classes
    Nameable
  263. def setPartialName(owner: Nameable, name: String): UInt.this.type
    Definition Classes
    Nameable
  264. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  265. def setScalaLocated(source: ScalaLocated): UInt.this.type
    Definition Classes
    ScalaLocated
  266. def setWeakName(name: String): UInt.this.type
    Definition Classes
    Nameable
  267. 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
  268. def simplifyNode: Expression
    Definition Classes
    Expression
  269. def spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  270. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  271. def subdivideIn(sliceWidth: BitCount): 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
  272. def subdivideIn(sliceCount: SlicesCount): 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)
  273. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  274. def toString(): String
    Definition Classes
    BitVectorBaseTypeExpressionNameable → AnyRef → Any
  275. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  276. def trim(m: Int): UInt

    highest m bits Discard

    highest m bits Discard

    Definition Classes
    UIntNum
  277. def trim(width: BitCount): UInt
    Definition Classes
    Num
  278. def twoComplement(enable: Bool): SInt

    2'Complement

    2'Complement

    enable

    enable the 2'complement

    returns

    Return the 2'Complement of the number

  279. def unary_~: UInt

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    UIntBitwiseOp
  280. def unsetName(): UInt.this.type
    Definition Classes
    Nameable
  281. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  282. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  283. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  284. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  285. def walkExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  286. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  287. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  288. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  289. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  290. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  291. def xorR: Bool

    Logical XOR of all bits

    Logical XOR of all bits

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

    Logical OR operator

    Logical OR operator

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

    Logical shift left (output width == input width)

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

    Logical shift left (output width == input width)

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

    Logical shift Right (output width == input width)

  296. 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[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