Packages

c

chisel3

Bool

sealed class Bool extends UInt with Reset

A data type for booleans, defined as a single bit indicating true or false.

Source
Bits.scala
Linear Supertypes
Reset, UInt, Num[UInt], Bits, ToBoolable, Element, Data, SourceInfoDoc, NamedComponent, HasId, internal.InstanceId, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Bool
  2. Reset
  3. UInt
  4. Num
  5. Bits
  6. ToBoolable
  7. Element
  8. Data
  9. SourceInfoDoc
  10. NamedComponent
  11. HasId
  12. InstanceId
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bool()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final macro def ##(that: Bits): UInt

    Concatenation operator

    Concatenation operator

    that

    a hardware component

    returns

    this Bits concatenated to the most significant end of that

    Definition Classes
    Bits
    Note

    The width of the returned Bits is width of this + width of that.

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

    Modulo operator

    Modulo operator

    that

    a hardware type

    returns

    the remainder of this numeric-like type divided by that

    Definition Classes
    Num
    Note

    This method generates a fully combinational divider which can result in significant cycle time and area costs.

  5. final macro def &(that: Bool): Bool

    Bitwise and operator

    Bitwise and operator

    that

    a hardware Bool

    returns

    the bitwise and of this Bool and that

  6. final macro def &(that: UInt): UInt

    Bitwise and operator

    Bitwise and operator

    that

    a hardware UInt

    returns

    the bitwise and of this UInt and that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that).

  7. macro def &&(that: Bool): Bool

    Logical and operator

    Logical and operator

    that

    a hardware Bool

    returns

    the lgocial and of this Bool and that

    Note

    this is equivalent to Bool.&

  8. final macro def *(that: SInt): SInt

    Multiplication operator

    Multiplication operator

    that

    a hardware SInt

    returns

    the product of this UInt and that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is width of this + width of that.

    ,

    This method generates a fully combinational multiplier which can result in significant cycle time and area costs.

  9. final macro def *(that: UInt): UInt

    Multiplication operator

    Multiplication operator

    that

    a hardware type

    returns

    the product of this numeric-like type and that

    Definition Classes
    Num
    Note

    The width of the returned hardware type is width of this + width of that.

    ,

    This method generates a fully combinational multiplier which can result in significant cycle time and area costs.

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

    Addition operator

    Addition operator

    that

    a hardware type

    returns

    the sum of this numeric-like type and that

    Definition Classes
    Num
    Note

    The width of the returned hardware type is max(width of this, width of that).

  11. final macro def +%(that: UInt): UInt

    Addition operator (constant width)

    Addition operator (constant width)

    that

    a hardware UInt

    returns

    the sum of this UInt and that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that).

  12. final macro def +&(that: UInt): UInt

    Addition operator (expanding width)

    Addition operator (expanding width)

    that

    a hardware UInt

    returns

    the sum of this UInt and that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that) + 1.

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

    Subtraction operator

    Subtraction operator

    that

    a hardware type

    returns

    the difference of this numeric-like type less that

    Definition Classes
    Num
    Note

    The width of the returned hardware type is max(width of this, width of that) + 1.

  14. final macro def -%(that: UInt): UInt

    Subtraction operator (constant width)

    Subtraction operator (constant width)

    that

    a hardware UInt

    returns

    the difference of this UInt less that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that).

  15. final macro def -&(that: UInt): UInt

    Subtraction operator (increasing width)

    Subtraction operator (increasing width)

    that

    a hardware UInt

    returns

    the difference of this UInt less that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that) + 1.

  16. final macro def /(that: UInt): UInt

    Division operator

    Division operator

    that

    a hardware type

    returns

    the quotient of this numeric-like type divided by that

    Definition Classes
    Num
    To do

    full rules

    Note

    This method generates a fully combinational divider which can result in significant cycle time and area costs.

  17. final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Connect this data to that data mono-directionally and element-wise.

    Connect this data to that data mono-directionally and element-wise.

    This uses the MonoConnect algorithm.

    that

    the data to connect to

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

    Less than operator

    Less than operator

    that

    a hardware type

    returns

    a hardware Bool asserted if this numeric-like type is less than that

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

    Dynamic left shift operator

    Dynamic left shift operator

    that

    a hardware component

    returns

    this Bits dynamically shifted left by that many places, shifting in zeros from the right

    Definition Classes
    Bits
    Note

    The width of the returned Bits is width of this + pow(2, width of that) - 1.

  20. final macro def <<(that: Int): Bits

    Static left shift operator

    Static left shift operator

    that

    an amount to shift by

    returns

    this Bits with that many zeros concatenated to its least significant end

    Definition Classes
    Bits
    Note

    The width of the returned Bits is width of this + that.

  21. final macro def <<(that: BigInt): Bits

    Static left shift operator

    Static left shift operator

    that

    an amount to shift by

    returns

    this Bits with that many zeros concatenated to its least significant end

    Definition Classes
    Bits
    Note

    The width of the returned Bits is width of this + that.

  22. final macro def <=(that: UInt): Bool

    Less than or equal to operator

    Less than or equal to operator

    that

    a hardware type

    returns

    a hardware Bool asserted if this numeric-like type is less than or equal to that

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

    Connect this data to that data bi-directionally and element-wise.

    Connect this data to that data bi-directionally and element-wise.

    This uses the BiConnect algorithm.

    that

    the data to connect to

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

    Dynamic not equals operator

    Dynamic not equals operator

    that

    a hardware UInt

    returns

    a hardware Bool asserted if this UInt is not equal to that

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

    Dynamic equals operator

    Dynamic equals operator

    that

    a hardware UInt

    returns

    a hardware Bool asserted if this UInt is equal to that

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

    Greater than operator

    Greater than operator

    that

    a hardware component

    returns

    a hardware Bool asserted if this numeric-like type is greater than that

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

    Greater than or equal to operator

    Greater than or equal to operator

    that

    a hardware component

    returns

    a hardware Bool asserted if this numeric-like type is greather than or equal to that

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

    Dynamic right shift operator

    Dynamic right shift operator

    that

    a hardware component

    returns

    this Bits dynamically shifted right by the value of that component, inserting zeros into the most significant bits.

    Definition Classes
    Bits
    Note

    The width of the returned Bits is unchanged, i.e., the width of this.

  30. final macro def >>(that: Int): Bits

    Static right shift operator

    Static right shift operator

    that

    an amount to shift by

    returns

    this Bits with that many least significant bits truncated

    Definition Classes
    Bits
    Note

    The width of the returned Bits is unchanged, i.e., the width of this.

  31. final macro def >>(that: BigInt): Bits

    Static right shift operator

    Static right shift operator

    that

    an amount to shift by

    returns

    this Bits with that many least significant bits truncated

    Definition Classes
    Bits
    Note

    The width of the returned Bits is unchanged, i.e., the width of this.

  32. final macro def ^(that: Bool): Bool

    Bitwise exclusive or (xor) operator

    Bitwise exclusive or (xor) operator

    that

    a hardware Bool

    returns

    the bitwise xor of this Bool and that

  33. final macro def ^(that: UInt): UInt

    Bitwise exclusive or (xor) operator

    Bitwise exclusive or (xor) operator

    that

    a hardware UInt

    returns

    the bitwise xor of this UInt and that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that).

  34. final macro def abs(): UInt

    Absolute value operator

    Absolute value operator

    returns

    a hardware type with a value equal to the absolute value of this numeric-like type

    Definition Classes
    Num
    Note

    The width of the returned hardware type is unchanged, i.e., the width of this.

  35. final macro def andR(): Bool

    And reduction operator

    And reduction operator

    returns

    a hardware Bool resulting from every bit of this UInt and'd together

    Definition Classes
    UInt
  36. final macro def apply(x: BigInt, y: BigInt): UInt

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

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

    x

    the high bit

    y

    the low bit

    returns

    a hardware component contain the requested bits

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

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

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

    x

    the high bit

    y

    the low bit

    returns

    a hardware component contain the requested bits

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

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

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

    x

    a hardware component whose value will be used for dynamic addressing

    returns

    the specified bit

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

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

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

    x

    an index

    returns

    the specified bit

    Definition Classes
    Bits
    Note

    convenience method allowing direct use of scala.Int without implicits

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

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

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

    x

    an index

    returns

    the specified bit

    Definition Classes
    Bits
  41. final macro def asAsyncReset(): AsyncReset

    Casts this element to an AsyncReset

    Casts this element to an AsyncReset

    Definition Classes
    Reset
  42. final macro def asBool(): Bool

    Casts this Bool to a Bool

    Casts this Bool to a Bool

    Definition Classes
    ToBoolable
    Note

    The width must be known and equal to 1

  43. final macro def asBools(): Seq[Bool]

    Returns the contents of this wire as a scala.collection.Seq of Bool.

    Returns the contents of this wire as a scala.collection.Seq of Bool.

    Definition Classes
    Bits
  44. macro def asClock(): Clock

    Reinterprets this Bool as a clock

  45. final macro def asFixedPoint(that: BinaryPoint): FixedPoint

    Reinterpret this Bits as a FixedPoint.

    Reinterpret this Bits as a FixedPoint.

    Definition Classes
    Bits
    Note

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

  46. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  47. final macro def asSInt(): SInt

    Reinterpret this Bits as an SInt

    Reinterpret this Bits as an SInt

    Definition Classes
    Bits
    Note

    The arithmetic value is not preserved if the most-significant bit is set. For example, a UInt of width 3 and value 7 (0b111) would become an SInt of width 3 and value -1.

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

    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

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

    ,

    that should have known widths

  49. final macro def asUInt(): UInt

    Reinterpret cast to UInt.

    Reinterpret cast to UInt.

    Definition Classes
    Data
    Note

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

    ,

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

  50. def binding: Option[Binding]
    Attributes
    protected[chisel3]
    Definition Classes
    Data
  51. def bindingToString: String
    Attributes
    protected
    Definition Classes
    Data
  52. def binding_=(target: Binding): Unit
    Attributes
    protected
    Definition Classes
    Data
  53. final macro def bitSet(off: UInt, dat: Bool): UInt

    Conditionally set or clear a bit

    Conditionally set or clear a bit

    off

    a dynamic offset

    dat

    set if true, clear if false

    returns

    a hrdware UInt with bit off set or cleared based on the value of dat

    Definition Classes
    UInt
    Note

    The width of the returned UInt is unchanged, i.e., the width of this.

  54. def circuitName: String
    Attributes
    protected
    Definition Classes
    HasId
  55. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  56. def cloneType: Bool.this.type

    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
  57. def do_##(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

    Definition Classes
    UIntNum
  59. def do_&(that: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

  60. def do_&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Definition Classes
    UInt
  61. def do_&&(that: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

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

    Definition Classes
    UInt
  63. def do_*(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

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

    Definition Classes
    UInt
  66. def do_+&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Definition Classes
    UInt
  67. def do_-(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

    Definition Classes
    UInt
  69. def do_-&(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Definition Classes
    UInt
  70. def do_/(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

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

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

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

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

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

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

    Definition Classes
    UInt
  78. def do_>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

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

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

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

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

    Definition Classes
    UIntBits
  83. def do_^(that: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

  84. def do_^(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Definition Classes
    UInt
  85. def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

    Definition Classes
    UInt
  87. final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

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

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

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

    Definition Classes
    Bits
  92. def do_asAsyncReset(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): AsyncReset

    Definition Classes
    BoolReset
  93. final def do_asBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Definition Classes
    Bits → ToBoolable
  94. def do_asBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]

    Definition Classes
    Bits
  95. def do_asClock(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Clock

  96. def do_asFixedPoint(binaryPoint: BinaryPoint)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): FixedPoint

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

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

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

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

    Definition Classes
    UInt
  101. def do_head(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

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

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

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

    Definition Classes
    UInt
  105. def do_pad(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool.this.type

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

    Definition Classes
    Bits
  107. def do_unary_!(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Definition Classes
    UInt
  108. def do_unary_-(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Definition Classes
    UInt
  109. def do_unary_-%(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Definition Classes
    UInt
  110. def do_unary_~(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Definition Classes
    BoolUIntBits
  111. def do_xorR(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Definition Classes
    UInt
  112. def do_zext(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt

    Definition Classes
    UInt
  113. def do_|(that: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

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

    Definition Classes
    UInt
  115. def do_||(that: Bool)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

  116. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  117. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  118. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  119. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  120. final def getWidth: Int

    Returns the width, in bits, if currently known.

    Returns the width, in bits, if currently known.

    Definition Classes
    Data
  121. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  122. final macro def head(n: Int): UInt

    Head operator

    Head operator

    n

    the number of bits to take

    returns

    The n most significant bits of this Bits

    Definition Classes
    Bits
  123. def instanceName: String
    Definition Classes
    HasId → InstanceId
  124. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  125. def isLit(): Boolean
    Definition Classes
    Data
  126. final def isWidthKnown: Boolean

    Returns whether the width is currently known.

    Returns whether the width is currently known.

    Definition Classes
    Data
  127. def litOption(): Option[BigInt]

    If this is a literal that is representable as bits, returns the value as a BigInt.

    If this is a literal that is representable as bits, returns the value as a BigInt. If not a literal, or not representable as bits (for example, is or contains Analog), returns None.

    Definition Classes
    ElementData
  128. def litToBoolean: Boolean

    Convert to a scala.Boolean

  129. def litToBooleanOption: Option[Boolean]

    Convert to a scala.Option of scala.Boolean

  130. def litValue(): BigInt

    Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

    Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

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

    Maximum operator

    Maximum operator

    that

    a hardware type

    returns

    a hardware type with a value equal to the mimimum value of this numeric-like type and that

    Definition Classes
    Num
    Note

    The width of the returned hardware type is max(width of this, width of that).

  132. final macro def min(that: UInt): UInt

    Minimum operator

    Minimum operator

    that

    a hardware numeric-like type

    returns

    a hardware type with a value equal to the mimimum value of this numeric-like type and that

    Definition Classes
    Num
    Note

    The width of the returned hardware type is max(width of this, width of that).

  133. def name: String
    Definition Classes
    Element
  134. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  135. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  136. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  137. final macro def orR(): Bool

    Or reduction operator

    Or reduction operator

    returns

    a hardware Bool resulting from every bit of this UInt or'd together

    Definition Classes
    UInt
  138. final macro def pad(that: Int): Bool.this.type

    Pad operator

    Pad operator

    that

    the width to pad to

    returns

    this @coll zero padded up to width that. If that is less than the width of the original component, this method returns the original component.

    Definition Classes
    Bits
    Note

    For SInts only, this will do sign extension.

  139. def parentModName: String
    Definition Classes
    HasId → InstanceId
  140. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  141. def pathName: String
    Definition Classes
    HasId → InstanceId
  142. def suggestName(name: ⇒ String): Bool.this.type
    Definition Classes
    HasId
  143. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  144. final macro def tail(n: Int): UInt

    Tail operator

    Tail operator

    n

    the number of bits to remove

    returns

    This Bits with the n most significant bits removed.

    Definition Classes
    Bits
  145. final def toAbsoluteTarget: ReferenceTarget

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Definition Classes
    NamedComponent → InstanceId
  146. final macro def toBool(): Bool

    Casts this Bool to a Bool

    Casts this Bool to a Bool

    Definition Classes
    ToBoolable
    Note

    The width must be known and equal to 1

  147. final macro def toBools(): Seq[Bool]

    Returns the contents of this wire as a scala.collection.Seq of Bool.

    Returns the contents of this wire as a scala.collection.Seq of Bool.

    Definition Classes
    Bits
  148. final def toPrintable: Printable

    Default print as Decimal

    Default print as Decimal

    Definition Classes
    BitsData
  149. def toString(): String
    Definition Classes
    BoolUInt → AnyRef → Any
  150. final def toTarget: ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object

    Returns a FIRRTL ReferenceTarget that references this object

    Definition Classes
    NamedComponent → InstanceId
    Note

    Should not be called until circuit elaboration is complete

  151. final macro def unary_!(): Bool

    Unary not

    Unary not

    returns

    a hardware Bool asserted if this UInt equals zero

    Definition Classes
    UInt
  152. final macro def unary_-(): UInt

    Unary negation (expanding width)

    Unary negation (expanding width)

    returns

    a UInt equal to zero minus this UInt

    Definition Classes
    UInt
    Note

    The width of the returned UInt is unchanged, i.e., width of this.

  153. final macro def unary_-%(): UInt

    Unary negation (constant width)

    Unary negation (constant width)

    returns

    a UInt equal to zero minus this UInt shifted right by one.

    Definition Classes
    UInt
    Note

    The width of the returned UInt is unchanged, i.e., width of this.

  154. final macro def unary_~(): Bits

    Bitwise inversion operator

    Bitwise inversion operator

    returns

    this Bits with each bit inverted

    Definition Classes
    Bits
  155. final def validateShiftAmount(x: Int): Int
    Attributes
    protected
    Definition Classes
    Bits
  156. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  158. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  159. def widthKnown: Boolean
    Definition Classes
    Element
  160. final def widthOption: Option[Int]

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

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

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

    Exclusive or (xor) reduction operator

    Exclusive or (xor) reduction operator

    returns

    a hardware Bool resulting from every bit of this UInt xor'd together

    Definition Classes
    UInt
  162. final macro def zext(): SInt

    Zero extend as SInt

    Zero extend as SInt

    returns

    an SInt equal to this UInt with an additional zero in its most significant bit

    Definition Classes
    UInt
    Note

    The width of the returned SInt is width of this + 1.

  163. final macro def |(that: Bool): Bool

    Bitwise or operator

    Bitwise or operator

    that

    a hardware Bool

    returns

    the bitwise or of this Bool and that

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

    Bitwise or operator

    Bitwise or operator

    that

    a hardware UInt

    returns

    the bitwise or of this UInt and that

    Definition Classes
    UInt
    Note

    The width of the returned UInt is max(width of this, width of that).

  165. macro def ||(that: Bool): Bool

    Logical or operator

    Logical or operator

    that

    a hardware Bool

    returns

    the lgocial or of this Bool and that

    Note

    this is equivalent to Bool.|)

Deprecated Value Members

  1. final def !=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
    Definition Classes
    UInt
    Annotations
    @chiselRuntimeDeprecated() @deprecated
    Deprecated

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

  2. final def do_toBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

    Definition Classes
    Bits → ToBoolable
    Annotations
    @chiselRuntimeDeprecated() @deprecated
    Deprecated

    (Since version 3.2) Use asBool instead

  3. def do_toBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]

    Definition Classes
    Bits
    Annotations
    @chiselRuntimeDeprecated() @deprecated
    Deprecated

    (Since version 3.2) Use asBools instead

  4. def litArg(): Option[LitArg]
    Definition Classes
    Data
    Annotations
    @chiselRuntimeDeprecated() @deprecated
    Deprecated

    (Since version 3.2) litArg is deprecated, use litOption or litTo*Option

  5. final def toNamed: ComponentName

    Returns a FIRRTL ComponentName that references this object

    Returns a FIRRTL ComponentName that references this object

    Definition Classes
    NamedComponent → InstanceId
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) toNamed API is deprecated -- use toTarget instead

    Note

    Should not be called until circuit elaboration is complete

Inherited from Reset

Inherited from UInt

Inherited from Num[UInt]

Inherited from Bits

Inherited from ToBoolable

Inherited from Element

Inherited from Data

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Arithmetic

Arithmetic hardware operators

Bitwise

Bitwise hardware operators

Comparison

Comparison hardware operators

Connect

Utilities for connecting hardware components

Logical

Logical hardware operators

Ungrouped

SourceInfoTransformMacro

These internal methods are not part of the public-facing API!

The equivalent public-facing methods do not have the do_ prefix or have the same name. Use and look at the documentation for those. If you want left shift, use <<, not do_<<. If you want conversion to a Seq of Bools look at the asBools above, not the one below. Users can safely ignore every method in this group!

🐉🐉🐉 Here be dragons... 🐉🐉🐉

These do_X methods are used to enable both implicit passing of SourceInfo and chisel3.CompileOptions while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your designs, are converted to their "hidden", do_*, via macro transformations. Without using macros here, only one of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a chained apply as an explicit 'implicit' argument and will throw type errors.

The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method into a call to an internal, hidden do_* that takes an explicit SourceInfo by inserting an implicitly[SourceInfo] as the explicit argument.