spinal.core

Bool

Related Doc: package core

class Bool extends BaseType with DataPrimitives[Bool] with BitwiseOp[Bool]

The Bool type corresponds to a boolean value (True or False)

Example:
  1. val myBool = Bool()
    myBool := False
    myBool := Bool(false)
See also

Bool Documentation

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Bool
  2. BitwiseOp
  3. DataPrimitives
  4. BaseType
  5. AssignementTreePart
  6. Data
  7. Assignable
  8. NameableByComponent
  9. Nameable
  10. OwnableRef
  11. Node
  12. SpinalTagReady
  13. ScalaLocated
  14. ContextUser
  15. GlobalDataUser
  16. AnyRef
  17. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bool()

Type Members

  1. case class MuxBuilder[T <: Data](whenTrue: T) extends Product with Serializable

    Class used to write conditional operation on Data value

    Class used to write conditional operation on Data value

    Example:
    1. val res = myBool ? myBits1 | myBits2
  2. case class MuxBuilderEnum[T <: SpinalEnum](whenTrue: SpinalEnumCraft[T]) extends Product with Serializable

    Class used to write conditional operation on Enumeration value

    Class used to write conditional operation on Enumeration value

    Example:
    1. val res = myBool ? myEnum1 | myEnum2
    Note

    implicit conversion is used to send SpinalEnumElement

  3. abstract type RefOwnerType

    Definition Classes
    OwnableRef

Value Members

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

    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

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

    Definition Classes
    AnyRef → Any
  4. def &(b: Bool): Bool

    Logical AND operator

    Logical AND operator

    Definition Classes
    BoolBitwiseOp
  5. def &&(b: Bool): Bool

    Logical AND

    Logical AND

    returns

    a Bool assign with the AND result

    Example:
    1. val result = myBool1 && myBool2
  6. def :=(that: Bool): Unit

    Definition Classes
    DataPrimitives
  7. def <>(that: Bool): Unit

    Definition Classes
    DataPrimitives
  8. def =/=(that: Bool): Bool

    Definition Classes
    DataPrimitives
  9. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def ===(that: Bool): Bool

    Definition Classes
    DataPrimitives
  11. def ?[T <: SpinalEnum](whenTrue: SpinalEnumCraft[T]): MuxBuilderEnum[T]

    Conditional operation for Enumeration value

  12. def ?[T <: Data](whenTrue: T): MuxBuilder[T]

    Conditional operation for Data value

  13. def \(that: Bool): Bool

    Definition Classes
    DataPrimitives
  14. def ^(b: Bool): Bool

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    BoolBitwiseOp
  15. var _spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  16. def addAttribute(attribute: Attribute): Bool.this.type

    Definition Classes
    BaseTypeDataSpinalTagReady
  17. def addAttribute(name: String, value: String): Bool.this.type

    Definition Classes
    SpinalTagReady
  18. def addAttribute(name: String): Bool.this.type

    Definition Classes
    SpinalTagReady
  19. def addTag(spinalTag: SpinalTag): Bool.this.type

    Definition Classes
    SpinalTagReady
  20. def addTags(tags: Iterable[SpinalTag]): Bool.this.type

    Definition Classes
    SpinalTagReady
  21. def allowPruning(): Unit

    Definition Classes
    Data
  22. def allowSimplifyIt(): Bool.this.type

    Definition Classes
    BaseTypeData
  23. def asBits: Bits

    Definition Classes
    BoolData
  24. def asBits(bitCount: BitCount): Bits

    Cast a Bool to an Bits of a given width

    Cast a Bool to an Bits of a given width

    bitCount

    the width of the Bits

    returns

    a Bits data of a given length initialize to this

  25. def asData: Data

    Definition Classes
    Data
  26. def asDirectionLess(): Bool.this.type

    Definition Classes
    BaseTypeData
  27. def asInput(): Bool.this.type

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

    Definition Classes
    Any
  29. def asOutput(): Bool.this.type

    Definition Classes
    BaseTypeData
  30. def asSInt: SInt

    Cast a Bool to an SInt

    Cast a Bool to an SInt

    returns

    a SInt data

    Example:
    1. mySInt := myBool.asSInt
  31. def asUInt(bitCount: BitCount): UInt

    Cast a Bool to an UInt of a given width

    Cast a Bool to an UInt of a given width

    bitCount

    the width of the UInt

    returns

    an UInt data of a given length initialize to this

    Example:
    1. myUInt := myBool.asUInt(8 bits)
  32. def asUInt: UInt

    Cast a Bool to an UInt

    Cast a Bool to an UInt

    returns

    an UInt data

    Example:
    1. myUInt := myBool.asUInt
  33. def assignDontCare(): Bool.this.type

    Definition Classes
    BaseTypeData
  34. final def assignFrom(that: AnyRef, conservative: Boolean): Unit

    Definition Classes
    Assignable
  35. def assignFromBits(bits: Bits, hi: Int, low: Int): Unit

    Definition Classes
    BoolData
  36. def assignFromBits(bits: Bits): Unit

    Definition Classes
    BoolData
  37. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Definition Classes
    Data
  38. var assignementThrowable: Throwable

    Definition Classes
    BaseType
  39. def clear(): Unit

    this is assigned to False

  40. def clearWhen(cond: Bool): Bool

    this is assigned to False when cond is True

  41. def clone(): Bool.this.type

    Definition Classes
    BaseTypeData → AnyRef
  42. var component: Component

    Definition Classes
    ContextUser
  43. var compositeAssign: Assignable

    Definition Classes
    Assignable
  44. val consumers: ArrayBuffer[Node]

    Definition Classes
    Node
  45. def default(that: ⇒ Bool): Bool

    Definition Classes
    DataPrimitives
  46. var defaultValue: BaseType

    Definition Classes
    BaseType
  47. def dontSimplifyIt(): Bool.this.type

    Definition Classes
    BaseTypeData
  48. def edge(): Bool

    Edge detection

  49. def edge(initAt: Bool): Bool

    Edge detection of this with an initial value

    Edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:
    1. val res = myBool.edge(False)
  50. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  51. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  52. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Definition Classes
    SpinalTagReady
  53. def fall(): Bool

    Falling edge detection

  54. def fall(initAt: Bool): Bool

    Falling edge detection of this with an initial value

    Falling edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:
    1. val res = myBool.fall(False)
  55. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Definition Classes
    SpinalTagReady
  56. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  57. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Definition Classes
    SpinalTagReady
  58. def flatten: Seq[BaseType]

    Definition Classes
    BaseTypeData
  59. def flattenLocalName: Seq[String]

    Definition Classes
    BaseTypeData
  60. def flip(): Bool.this.type

    Definition Classes
    Data
  61. def forEachNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable
  62. def genIf(cond: Boolean): Bool.this.type

    Definition Classes
    Data
  63. def getAssignementContext(id: Int): Throwable

    Definition Classes
    BaseTypeAssignementTreePart
  64. def getBitsWidth: Int

    Definition Classes
    BoolData
  65. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  66. def getComponent(): Component

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

    Definition Classes
    Data
  68. def getDisplayName(): String

    Definition Classes
    Nameable
  69. def getDrivingReg: Bool.this.type

    Definition Classes
    BaseType
  70. def getInput(id: Int): Node

    Definition Classes
    BaseTypeNode
  71. def getInputs: Iterator[Node]

    Definition Classes
    BaseTypeNode
  72. def getInputsCount: Int

    Definition Classes
    BaseTypeNode
  73. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  74. def getName(): String

    Definition Classes
    NameableByComponentNameable
  75. def getName(default: String): String

    Definition Classes
    Nameable
  76. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef
  77. def getRootParent: Data

    Definition Classes
    Data
  78. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  79. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  80. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Definition Classes
    SpinalTagReady
  81. def getZero: Bool.this.type

    Definition Classes
    BoolData
  82. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  83. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  84. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  85. def init(that: Bool): Bool

    Definition Classes
    DataPrimitives
  86. var input: Node

    Definition Classes
    BaseType
  87. def instanceAndSyncNodeAttributes: Iterable[Attribute]

    Definition Classes
    BaseType
  88. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  89. def isDelay: Boolean

    Definition Classes
    BaseType
  90. def isDirectionLess: Boolean

    Definition Classes
    Data
  91. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  92. def isInput: Boolean

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

    Definition Classes
    Any
  94. def isNamed: Boolean

    Definition Classes
    Nameable
  95. def isOutput: Boolean

    Definition Classes
    Data
  96. def isReg: Boolean

    Definition Classes
    BaseTypeData
  97. def isUnnamed: Boolean

    Definition Classes
    Nameable
  98. def keep(): Bool.this.type

    Definition Classes
    Data
  99. def mux[T <: Data](mappings: (Any, T)*): T

    Definition Classes
    DataPrimitives
  100. def muxList[T <: Data](mappings: Seq[(Any, T)]): T

    Definition Classes
    DataPrimitives
  101. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  102. final def notify(): Unit

    Definition Classes
    AnyRef
  103. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  104. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Definition Classes
    SpinalTagReady
  105. def onEachInput(doThat: (Node) ⇒ Unit): Unit

    Definition Classes
    BaseTypeNode
  106. def onEachInput(doThat: (Node, Int) ⇒ Unit): Unit

    Definition Classes
    BaseTypeNode
  107. var parent: Data

    Definition Classes
    Data
  108. def pull(): Bool.this.type

    Definition Classes
    Data
  109. def randBoot(): Bool.this.type

    Definition Classes
    Data
  110. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  111. def removeAssignements(): Unit

    Definition Classes
    BaseType
  112. def removeTag(spinalTag: SpinalTag): Bool.this.type

    Definition Classes
    SpinalTagReady
  113. def removeTags(tags: Iterable[SpinalTag]): Bool.this.type

    Definition Classes
    SpinalTagReady
  114. def resized: Bool.this.type

    Definition Classes
    Data
  115. def rise(): Bool

    Rising edge detection

  116. def rise(initAt: Bool): Bool

    Rising edge detection of this with an initial value

    Rising edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:
    1. val res = myBool.rise(False)
  117. def set(): Unit

    this is assigned to True

  118. def setAssignementContext(id: Int, that: Throwable): Unit

    Definition Classes
    BaseTypeAssignementTreePart
  119. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Bool.this.type

    Definition Classes
    Nameable
  120. def setCompositeName(nameable: Nameable, postfix: String): Bool.this.type

    Definition Classes
    Nameable
  121. def setCompositeName(nameable: Nameable, weak: Boolean): Bool.this.type

    Definition Classes
    Nameable
  122. def setCompositeName(nameable: Nameable): Bool.this.type

    Definition Classes
    Nameable
  123. def setInput(id: Int, node: Node): Unit

    Definition Classes
    BaseTypeNode
  124. def setName(name: String, weak: Boolean = false): Bool.this.type

    Definition Classes
    Nameable
  125. def setPartialName(name: String, weak: Boolean): Bool.this.type

    Definition Classes
    Nameable
  126. def setPartialName(owner: Nameable, name: String, weak: Boolean): Bool.this.type

    Definition Classes
    Nameable
  127. def setPartialName(name: String): Bool.this.type

    Definition Classes
    Nameable
  128. def setPartialName(owner: Nameable, name: String): Bool.this.type

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

    Definition Classes
    OwnableRef
  130. def setWeakName(name: String): Bool.this.type

    Definition Classes
    Nameable
  131. def setWhen(cond: Bool): Bool

    this is assigned to True when cond is True

    this is assigned to True when cond is True

    cond

    a Bool condition

    returns

    this is assigned to True when cond is True

    Example:
    1. myBool.setWhen(cond)
  132. def simplifyNode: Unit

    Definition Classes
    Node
  133. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  134. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  135. def toString(): String

    Definition Classes
    BaseTypeNameableNode → AnyRef → Any
  136. def unary_!(): Bool

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

    Example:
    1. val result = !myBool1
  137. def unary_~(): Bool

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    BoolBitwiseOp
  138. def unsetName(): Unit

    Definition Classes
    Nameable
  139. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  142. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Definition Classes
    BaseType
  143. def |(b: Bool): Bool

    Logical OR operator

    Logical OR operator

    Definition Classes
    BoolBitwiseOp
  144. def ||(b: Bool): Bool

    Logical OR

    Logical OR

    returns

    a Bool assign with the OR result

    Example:
    1. val result = myBool1 || myBool2

Deprecated Value Members

  1. def !==(that: Bool): Bool

    Definition Classes
    DataPrimitives
    Annotations
    @deprecated
    Deprecated

    Use =/= instead

  2. def unused: Unit

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    use allowPruning instead

Inherited from BitwiseOp[Bool]

Inherited from DataPrimitives[Bool]

Inherited from BaseType

Inherited from AssignementTreePart

Inherited from Data

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from Node

Inherited from SpinalTagReady

Inherited from ScalaLocated

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped