Class/Object

chisel3.core

UInt

Related Docs: object UInt | package core

Permalink

sealed class UInt extends Bits with Num[UInt]

A data type for unsigned integers, represented as a binary bitvector. Defines arithmetic operations between other integer types.

Linear Supertypes
Num[UInt], Bits, ToBoolable, Element, Data, HasId, InstanceId, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UInt
  2. Num
  3. Bits
  4. ToBoolable
  5. Element
  6. Data
  7. HasId
  8. InstanceId
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final macro def ##(that: Bits): UInt

    Permalink

    Returns this wire concatenated with other, where this wire forms the most significant part and other forms the least significant part.

    Returns this wire concatenated with other, where this wire forms the most significant part and other forms the least significant part.

    The width of the output is sum of the inputs.

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final macro def %(that: UInt): UInt

    Permalink
    Definition Classes
    Num
  5. final macro def &(that: UInt): UInt

    Permalink
  6. final macro def *(that: SInt): SInt

    Permalink
  7. final macro def *(that: UInt): UInt

    Permalink

    Outputs the product of this and b.

    Outputs the product of this and b. The resulting width is the sum of the operands.

    Definition Classes
    Num
    Note

    can generate a single-cycle multiplier, which can result in significant cycle time and area costs

  8. final macro def +(that: UInt): UInt

    Permalink

    Outputs the sum of this and b.

    Outputs the sum of this and b. The resulting width is the max of the operands plus 1 (should not overflow).

    Definition Classes
    Num
  9. final macro def +%(that: UInt): UInt

    Permalink
  10. final macro def +&(that: UInt): UInt

    Permalink
  11. final macro def -(that: UInt): UInt

    Permalink

    Outputs the difference of this and b.

    Outputs the difference of this and b. The resulting width is the max of the operands plus 1 (should not overflow).

    Definition Classes
    Num
  12. final macro def -%(that: UInt): UInt

    Permalink
  13. final macro def -&(that: UInt): UInt

    Permalink
  14. final macro def /(that: UInt): UInt

    Permalink

    Outputs the quotient of this and b.

    Outputs the quotient of this and b.

    TODO: full rules

    Definition Classes
    Num
  15. final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
    Definition Classes
    Data
  16. final macro def <(that: UInt): Bool

    Permalink

    Outputs true if this < b.

    Outputs true if this < b.

    Definition Classes
    Num
  17. final macro def <<(that: UInt): Bits

    Permalink

    Returns this wire dynamically left shifted by the specified amount, inserting zeros into the least significant bits.

    Returns this wire dynamically left shifted by the specified amount, inserting zeros into the least significant bits.

    The width of the output is pow(2, width(other)) larger than the input.

    Definition Classes
    Bits
  18. final macro def <<(that: Int): Bits

    Permalink

    Returns this wire statically left shifted by the specified amount, inserting zeros into the least significant bits.

    Returns this wire statically left shifted by the specified amount, inserting zeros into the least significant bits.

    The width of the output is other larger than the input.

    Definition Classes
    Bits
  19. final macro def <<(that: BigInt): Bits

    Permalink

    Shift left operation

    Shift left operation

    Definition Classes
    Bits
  20. final macro def <=(that: UInt): Bool

    Permalink

    Outputs true if this <= b.

    Outputs true if this <= b.

    Definition Classes
    Num
  21. final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
    Definition Classes
    Data
  22. final macro def =/=(that: UInt): Bool

    Permalink
  23. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. final macro def ===(that: UInt): Bool

    Permalink
  25. final macro def >(that: UInt): Bool

    Permalink

    Outputs true if this > b.

    Outputs true if this > b.

    Definition Classes
    Num
  26. final macro def >=(that: UInt): Bool

    Permalink

    Outputs true if this >= b.

    Outputs true if this >= b.

    Definition Classes
    Num
  27. final macro def >>(that: UInt): Bits

    Permalink

    Returns this wire dynamically right shifted by the specified amount, inserting zeros into the most significant bits.

    Returns this wire dynamically right shifted by the specified amount, inserting zeros into the most significant bits.

    The width of the output is the same as the input.

    Definition Classes
    Bits
  28. final macro def >>(that: Int): Bits

    Permalink

    Returns this wire statically right shifted by the specified amount, inserting zeros into the most significant bits.

    Returns this wire statically right shifted by the specified amount, inserting zeros into the most significant bits.

    The width of the output is the same as the input.

    Definition Classes
    Bits
  29. final macro def >>(that: BigInt): Bits

    Permalink

    Shift right operation

    Shift right operation

    Definition Classes
    Bits
  30. final macro def ^(that: UInt): UInt

    Permalink
  31. final macro def abs(): UInt

    Permalink

    Outputs the absolute value of this.

    Outputs the absolute value of this. The resulting width is the unchanged

    Definition Classes
    Num
  32. final macro def andR(): Bool

    Permalink
  33. final macro def apply(x: BigInt, y: BigInt): UInt

    Permalink
    Definition Classes
    Bits
  34. final macro def apply(x: Int, y: Int): UInt

    Permalink

    Returns a subset of bits on this wire from hi to lo (inclusive), statically addressed.

    Returns a subset of bits on this wire from hi to lo (inclusive), statically addressed.

    Definition Classes
    Bits
    Example:
    1. myBits = 0x5 = 0b101
      myBits(1,0) => 0b01  // extracts the two least significant bits
  35. final macro def apply(x: UInt): Bool

    Permalink

    Returns the specified bit on this wire as a Bool, dynamically addressed.

    Returns the specified bit on this wire as a Bool, dynamically addressed.

    Definition Classes
    Bits
  36. final macro def apply(x: Int): Bool

    Permalink

    Returns the specified bit on this wire as a Bool, statically addressed.

    Returns the specified bit on this wire as a Bool, statically addressed.

    Definition Classes
    Bits
    Note

    convenience method allowing direct use of Ints without implicits

  37. final macro def apply(x: BigInt): Bool

    Permalink

    Returns the specified bit on this wire as a Bool, statically addressed.

    Returns the specified bit on this wire as a Bool, statically addressed.

    Definition Classes
    Bits
  38. final macro def asFixedPoint(that: BinaryPoint): FixedPoint

    Permalink

    Reinterpret cast as a FixedPoint.

    Reinterpret cast as a FixedPoint.

    Definition Classes
    Bits
    Note

    value not guaranteed to be preserved: for example, an UInt of width 3 and value 7 (0b111) would become a FixedInt with value -1, the interpretation of the number is also affected by the specified binary point. Caution advised

  39. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  40. final macro def asSInt(): SInt

    Permalink

    Reinterpret cast to a SInt.

    Reinterpret cast to a SInt.

    Definition Classes
    Bits
    Note

    value not guaranteed to be preserved: for example, an UInt of width 3 and value 7 (0b111) would become a SInt with value -1

  41. macro def asTypeOf[T <: Data](that: T): T

    Permalink

    Does a reinterpret cast of the bits in this node into the format that provides.

    Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.

    x.asTypeOf(that) performs the inverse operation of x := that.toBits.

    Definition Classes
    Data
    Note

    that should have known widths

    ,

    bit widths are NOT checked, may pad or drop bits from input

  42. final macro def asUInt(): UInt

    Permalink

    Reinterpret cast to UInt.

    Reinterpret cast to UInt.

    Definition Classes
    Data
    Note

    Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.

    ,

    value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7

  43. def binding_=(target: Binding): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  44. final macro def bitSet(off: UInt, dat: Bool): UInt

    Permalink
  45. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def cloneType: UInt.this.type

    Permalink

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned.

    returns

    a copy of the object.

    Definition Classes
    BitsData
  47. def do_!=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  48. def do_##(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Bits
  49. def do_%(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntNum
  50. def do_&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  51. def do_*(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

    Permalink
  52. def do_*(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntNum
  53. def do_+(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntNum
  54. def do_+%(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  55. def do_+&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  56. def do_-(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntNum
  57. def do_-%(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  58. def do_-&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  59. def do_/(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntNum
  60. def do_<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    UIntNum
  61. def do_<<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntBits
  62. def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntBits
  63. def do_<<(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntBits
  64. def do_<=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    UIntNum
  65. def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  66. def do_===(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  67. def do_>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    UIntNum
  68. def do_>=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    UIntNum
  69. def do_>>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntBits
  70. def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntBits
  71. def do_>>(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntBits
  72. def do_^(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  73. def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntNum
  74. def do_andR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  75. final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Bits
  76. final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Bits
  77. final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    Bits
  78. final def do_apply(x: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    Bits
  79. final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    Bits
  80. def do_asBits(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bits

    Permalink
    Definition Classes
    Bits
  81. def do_asFixedPoint(binaryPoint: BinaryPoint)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): FixedPoint

    Permalink
    Definition Classes
    UIntBits
  82. def do_asSInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

    Permalink

    Returns this UInt as a SInt, without changing width or bit value.

    Returns this UInt as a SInt, without changing width or bit value. The SInt is not guaranteed to have the same value (for example, if the MSB is high, it will be interpreted as a negative value).

    Definition Classes
    UIntBits
  83. def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

    Permalink
    Definition Classes
    Data
  84. def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    UIntData
  85. def do_bitSet(off: UInt, dat: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  86. def do_head(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Bits
  87. def do_max(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Num
  88. def do_min(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Num
  89. def do_orR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  90. def do_pad(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt.this.type

    Permalink
    Definition Classes
    Bits
  91. def do_tail(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Bits
  92. final def do_toBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
    Definition Classes
    Bits → ToBoolable
  93. def do_unary_!(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  94. def do_unary_-(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  95. def do_unary_-%(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  96. def do_unary_~(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink

    Returns this wire bitwise-inverted.

    Returns this wire bitwise-inverted.

    Definition Classes
    UIntBits
  97. def do_xorR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Permalink
  98. def do_zext(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

    Permalink
  99. def do_|(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
  100. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  101. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  102. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  103. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  104. final def getWidth: Int

    Permalink

    Returns the width, in bits, if currently known.

    Returns the width, in bits, if currently known.

    Definition Classes
    Data
    Exceptions thrown

    java.util.NoSuchElementException if the width is not known.

  105. def hashCode(): Int

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  106. final macro def head(n: Int): UInt

    Permalink
    Definition Classes
    Bits
  107. def instanceName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  108. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  109. def isLit(): Boolean

    Permalink
    Definition Classes
    Data
  110. final def isWidthKnown: Boolean

    Permalink

    Returns whether the width is currently known.

    Returns whether the width is currently known.

    Definition Classes
    Data
  111. val litArg: Option[LitArg]

    Permalink
    Definition Classes
    BitsData
  112. def litValue(): BigInt

    Permalink
    Definition Classes
    Data
  113. final macro def max(that: UInt): UInt

    Permalink

    Outputs the maximum of this and b.

    Outputs the maximum of this and b. The resulting width is the max of the operands.

    Definition Classes
    Num
  114. final macro def min(that: UInt): UInt

    Permalink

    Outputs the minimum of this and b.

    Outputs the minimum of this and b. The resulting width is the max of the operands.

    Definition Classes
    Num
  115. def name: String

    Permalink
    Definition Classes
    Element
  116. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  117. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  118. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  119. final macro def orR(): Bool

    Permalink
  120. final macro def pad(that: Int): UInt.this.type

    Permalink

    Returns this wire zero padded up to the specified width.

    Returns this wire zero padded up to the specified width.

    Definition Classes
    Bits
    Note

    for SInts only, this does sign extension

  121. def parentModName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  122. def parentPathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  123. def pathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  124. def suggestName(name: ⇒ String): UInt.this.type

    Permalink
    Definition Classes
    HasId
  125. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  126. final macro def tail(n: Int): UInt

    Permalink
    Definition Classes
    Bits
  127. final macro def toBool(): Bool

    Permalink

    Casts this object to a Bool

    Casts this object to a Bool

    Definition Classes
    ToBoolable
    Note

    Width must be known and equal to 1

  128. def toBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]

    Permalink
    Definition Classes
    Bits
  129. final macro def toBools(): Seq[Bool]

    Permalink

    Returns the contents of this wire as a Vec of Bools.

    Returns the contents of this wire as a Vec of Bools.

    Definition Classes
    Bits
  130. final def toPrintable: Printable

    Permalink

    Default print as Decimal

    Default print as Decimal

    Definition Classes
    BitsData
  131. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  132. final macro def unary_!(): Bool

    Permalink
  133. final macro def unary_-(): UInt

    Permalink
  134. final macro def unary_-%(): UInt

    Permalink
  135. final macro def unary_~(): Bits

    Permalink

    Returns this wire bitwise-inverted.

    Returns this wire bitwise-inverted.

    Definition Classes
    Bits
  136. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  139. def widthKnown: Boolean

    Permalink
    Definition Classes
    Element
  140. final def widthOption: Option[Int]

    Permalink

    Returns Some(width) if the width is known, else None.

    Returns Some(width) if the width is known, else None.

    Definition Classes
    Data
  141. final macro def xorR(): Bool

    Permalink
  142. final macro def zext(): SInt

    Permalink

    Returns this UInt as a SInt with an additional zero in the MSB.

  143. final macro def |(that: UInt): UInt

    Permalink

Deprecated Value Members

  1. final macro def !=(that: UInt): Bool

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version chisel3) Use '=/=', which avoids potential precedence problems

  2. final macro def asBits(): Bits

    Permalink

    Reinterpret cast to Bits.

    Reinterpret cast to Bits.

    Definition Classes
    Bits
    Annotations
    @deprecated
    Deprecated

    (Since version chisel3) Use asUInt, which does the same thing but returns a more concrete type

  3. def toBits(implicit compileOptions: CompileOptions): UInt

    Permalink

    Packs the value of this object as plain Bits.

    Packs the value of this object as plain Bits.

    This performs the inverse operation of fromBits(Bits).

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version chisel3) Best alternative, .asUInt()

  4. final def toSInt(implicit compileOptions: CompileOptions): SInt

    Permalink
    Definition Classes
    Bits
    Annotations
    @deprecated
    Deprecated

    (Since version chisel3) Use asSInt, which makes the reinterpret cast more explicit

  5. final def toUInt(implicit compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Bits
    Annotations
    @deprecated
    Deprecated

    (Since version chisel3) Use asUInt, which makes the reinterpret cast more explicit

Inherited from Num[UInt]

Inherited from Bits

Inherited from ToBoolable

Inherited from Element

Inherited from Data

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped