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. Expression
  6. StatementDoubleLinkedContainer
  7. DoubleLinkedContainer
  8. DeclarationStatement
  9. LeafStatement
  10. Statement
  11. BaseNode
  12. ExpressionContainer
  13. Data
  14. ScalaLocated
  15. SpinalTagReady
  16. Assignable
  17. NameableByComponent
  18. Nameable
  19. OwnableRef
  20. ContextUser
  21. GlobalDataUser
  22. AnyRef
  23. 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

    Concatenation between two data

    Concatenation between two data

    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

    Assign a data to this

    Assign a data to this

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

    Auto connection between two data

    Auto connection between two data

    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

    Comparison between two data

    Comparison between two data

    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

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

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

    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. var algoIncrementale: Int

    Definition Classes
    BaseNode
  22. var algoInt: Int

    Definition Classes
    BaseNode
  23. def allowDirectionLessIo: Bool.this.type

    Definition Classes
    Data
  24. def allowOverride: Bool.this.type

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  25. def allowPruning(): Bool.this.type

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

    Definition Classes
    BaseTypeData
  27. def allowUnsetRegToAvoidLatch: Bool.this.type

    Definition Classes
    Data
  28. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    BoolData
  29. 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

  30. def asData: Data

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

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

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

    Definition Classes
    BaseTypeData
  32. def asInOut(): Bool.this.type

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

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

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

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  36. def asSInt: SInt

    Cast a Bool to an SInt

    Cast a Bool to an SInt

    returns

    a SInt data

    Example:
    1. mySInt := myBool.asSInt
  37. 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)
  38. def asUInt: UInt

    Cast a Bool to an UInt

    Cast a Bool to an UInt

    returns

    an UInt data

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

    Definition Classes
    BoolData
  40. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

    Definition Classes
    Data
  41. def assignFromBits(bits: Bits, hi: Int, low: Int): Unit

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

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

    Definition Classes
    Data
  44. def clear(): Unit

    this is assigned to False

  45. def clearWhen(cond: Bool): Bool

    this is assigned to False when cond is True

  46. var clockDomain: ClockDomain

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

    Definition Classes
    BaseTypeData → AnyRef
  48. def component: Component

    Definition Classes
    ContextUser
  49. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Definition Classes
    Assignable
  50. var compositeAssign: Assignable

    Definition Classes
    Assignable
  51. def default(that: ⇒ Bool): Bool

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  52. def dirString(): String

    Definition Classes
    Data
  53. def dlcAppend(that: AssignmentStatement): Bool.this.type

    Definition Classes
    DoubleLinkedContainer
  54. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

    Definition Classes
    DoubleLinkedContainer
  55. def dlcHasOnlyOne: Boolean

    Definition Classes
    DoubleLinkedContainer
  56. var dlcHead: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer
  57. def dlcIsEmpty: Boolean

    Definition Classes
    DoubleLinkedContainer
  58. var dlcLast: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer
  59. def dlcPrepend(that: AssignmentStatement): Bool.this.type

    Definition Classes
    DoubleLinkedContainer
  60. def dontSimplifyIt(): Bool.this.type

    Definition Classes
    BaseTypeData
  61. def edge(): Bool

    Edge detection

  62. 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)
  63. def edges(): BoolEdges

    Edge detection without intial value

  64. def edges(initAt: Bool): BoolEdges

    Detect all edges (falling, rising, toogling)

    Detect all edges (falling, rising, toogling)

    initAt

    the initial value

    returns

    a BoolEdges

    Example:
    1. val res = myBool.edges()
      when(res.fall){...}
      when(res.rise){...}
      when(res.toggle){...}
  65. final def eq(arg0: AnyRef): Boolean

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

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

    Definition Classes
    SpinalTagReady
  68. def fall(): Bool

    Falling edge detection

  69. 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)
  70. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Definition Classes
    SpinalTagReady
  71. def finalize(): Unit

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

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

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

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

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  76. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

    Definition Classes
    BaseTypeStatement
  77. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    ExpressionContainer
  78. def foreachExpression(func: (Expression) ⇒ Unit): Unit

  79. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable
  80. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

  81. def genIf(cond: Boolean): Bool.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  82. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

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

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

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  86. def getDisplayName(): String

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

    Definition Classes
    BaseType
  88. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  89. def getName(): String

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

    Definition Classes
    Nameable
  91. def getRealSource: Any

    Definition Classes
    Assignable
  92. def getRealSourceNoRec: Any

    Definition Classes
    DataAssignable
  93. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef
  94. def getRootParent: Data

    Definition Classes
    Data
  95. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  96. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  97. def getSingleDriver: Option[Bool.this.type]

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

    Definition Classes
    SpinalTagReady
  99. def getTypeObject: TypeBool.type

    Definition Classes
    BoolExpression
  100. def getZero: Bool.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    BoolData
  101. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  102. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  103. def hasOnlyOneStatement: Boolean

  104. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  105. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  106. def head: AssignmentStatement

  107. def init(that: Bool): Bool

    Set inital value to a data

    Set inital value to a data

    Definition Classes
    DataPrimitives
  108. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Definition Classes
    Data
  109. def insertNext(s: Statement): Unit

    Definition Classes
    Statement
  110. def instanceAttributes(language: Language): Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  111. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  112. def isAnalog: Boolean

    Definition Classes
    BaseTypeData
  113. def isComb: Boolean

    Definition Classes
    BaseTypeData
  114. def isDirectionLess: Boolean

    Definition Classes
    Data
  115. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  116. def isInOut: Boolean

    Definition Classes
    Data
  117. def isInput: Boolean

    Definition Classes
    Data
  118. def isInputOrInOut: Boolean

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

    Definition Classes
    Any
  120. def isNamed: Boolean

    Definition Classes
    Nameable
  121. def isOutput: Boolean

    Definition Classes
    Data
  122. def isOutputOrInOut: Boolean

    Definition Classes
    Data
  123. def isReg: Boolean

    Definition Classes
    BaseTypeData
  124. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  125. def isUnnamed: Boolean

    Definition Classes
    Nameable
  126. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  127. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  128. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  129. def keep(): Bool.this.type

    Definition Classes
    Data
  130. var lastScopeStatement: Statement

    Definition Classes
    Statement
  131. def mux[T2 <: Data](mappings: (Any, T2)*): T2

    Definition Classes
    BaseType
  132. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Definition Classes
    BaseType
  133. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Definition Classes
    BaseType
  134. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  135. var nextScopeStatement: Statement

    Definition Classes
    Statement
  136. def noBackendCombMerge: Bool.this.type

    Definition Classes
    Data
  137. def noCombLoopCheck: Bool.this.type

    Definition Classes
    Data
  138. def normalizeInputs: Unit

    Definition Classes
    BaseTypeExpressionContainer
  139. final def notify(): Unit

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

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

    Definition Classes
    SpinalTagReady
  142. def opName: String

    Definition Classes
    BoolExpression
  143. var parent: Data

    Definition Classes
    Data
  144. var parentScope: ScopeStatement

    Definition Classes
    ContextUser
  145. def pull(): Bool.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
  146. def randBoot(): Bool.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
  147. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  148. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    ExpressionContainer
  149. def remapExpressions(func: (Expression) ⇒ Expression): Unit

  150. def removeAssignments(): Bool.this.type

    Remove all assignements of the base type

    Remove all assignements of the base type

    Definition Classes
    BaseTypeData
  151. def removeStatement(): Unit

    Definition Classes
    BaseTypeStatement
  152. def removeStatementFromScope(): Unit

    Definition Classes
    Statement
  153. def removeTag(spinalTag: SpinalTag): Bool.this.type

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

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

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  156. def rise(): Bool

    Rising edge detection

  157. 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)
  158. def rootScopeStatement: ScopeStatement

    Definition Classes
    BaseTypeStatement
  159. def set(): Unit

    this is assigned to True

  160. def setAsAnalog(): Bool.this.type

    Definition Classes
    BaseTypeData
  161. def setAsComb(): Bool.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType
  162. def setAsReg(): Bool.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType
  163. def setAsTypeNode(): Bool.this.type

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  164. def setAsVital(): Bool.this.type

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    OwnableRef
  175. def setScalaLocated(source: ScalaLocated): Bool.this.type

    Definition Classes
    ScalaLocated
  176. def setWeakName(name: String): Bool.this.type

    Definition Classes
    Nameable
  177. 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)
  178. def simplifyNode: Expression

    Definition Classes
    Expression
  179. def spinalTags: Set[SpinalTag]

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

    Definition Classes
    AnyRef
  181. def toString(): String

    Definition Classes
    BaseTypeExpressionNameable → AnyRef → Any
  182. def toStringMultiLine(): String

    Definition Classes
    BaseNode
  183. def unary_!(): Bool

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

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

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    BoolBitwiseOp
  185. def unsetName(): Bool.this.type

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  189. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    ExpressionContainer
  190. def walkExpression(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    ExpressionContainer
  191. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

    Definition Classes
    Statement
  192. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

    Definition Classes
    Statement
  193. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    ExpressionContainer
  194. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    ExpressionContainer
  195. def wrapCast[T <: BaseType](result: T, node: Cast): T

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

    Logical OR operator

    Logical OR operator

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

    Logical OR

    Logical OR

    returns

    a Bool assign with the OR result

    Example:
    1. val result = myBool1 || myBool2

Inherited from BitwiseOp[Bool]

Inherited from DataPrimitives[Bool]

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 ScalaLocated

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped