spinal.core

BitVector

Related Doc: package core

abstract class BitVector extends BaseType with Widthable

BitVector is a family of types for storing multiple bits of information in a single value. This type has three subtypes that can be used to model different behaviours:

See also

BitVector Documentation

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BitVector
  2. Widthable
  3. WidthProvider
  4. BaseType
  5. Expression
  6. StatementDoubleLinkedContainer
  7. DoubleLinkedContainer
  8. DeclarationStatement
  9. LeafStatement
  10. Statement
  11. BaseNode
  12. ExpressionContainer
  13. Data
  14. SpinalTagReady
  15. Assignable
  16. NameableByComponent
  17. Nameable
  18. OwnableRef
  19. ContextUser
  20. ScalaLocated
  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 BitVector()

Type Members

  1. abstract type RefOwnerType

    Definition Classes
    OwnableRef
  2. abstract type T <: BitVector

    Used to know the data type of the children class of BitVector

Abstract Value Members

  1. abstract def apply(offset: UInt, bitCount: BitCount): BitVector.this.type

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Example:
    1. val myBool = myBits(myUInt, 2 bits)
  2. abstract def apply(offset: Int, bitCount: BitCount): BitVector.this.type

    Return a range of bits at offset and of width bitCount

    Return a range of bits at offset and of width bitCount

    Example:
    1. val myBool = myBits(3, 2 bits)
  3. abstract def apply(bitId: UInt): Bool

    Return the bit at index bitId

    Return the bit at index bitId

    Example:
    1. val myBool = myBits(myUInt)
  4. abstract def apply(bitId: Int): Bool

    Return the bit at index bitId

    Return the bit at index bitId

    Example:
    1. val myBool = myBits(3)
  5. abstract def asBits: Bits

    Cast data to Bits

    Cast data to Bits

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

    Definition Classes
    Data
  7. abstract def assignFromBits(bits: Bits): Unit

    Definition Classes
    Data
  8. abstract def getAllTrue: BitVector.this.type

  9. abstract def getTypeObject: Any

    Definition Classes
    Expression
  10. abstract def getZero: BitVector.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    Data
  11. abstract def getZeroUnconstrained: BitVector.this.type

  12. abstract def opName: String

    Definition Classes
    Expression
  13. abstract def resize(width: BitCount): BitVector

  14. abstract def resize(width: Int): BitVector

    Resize the bitVector to width

    Resize the bitVector to width

    returns

    a resized bitVector

    Example:
    1. val res = myBits.resize(10)
  15. abstract def rotateLeft(that: Int): T

    Left rotation of that bits

  16. abstract def rotateRight(that: Int): T

    Right rotation of that bits

  17. abstract def setAll(): Unit

    Set all bits

Concrete 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 =/=(that: MaskedLiteral): Bool

    BitVector is not equal to MaskedLiteral

  5. final def ==(arg0: Any): Boolean

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

    Compare a BitVector with a MaskedLiteral (M"110--0")

    Compare a BitVector with a MaskedLiteral (M"110--0")

    that

    the maskedLiteral

    returns

    a Bool data containing the result of the comparison

    Example:
    1. val myBool = myBits === M"0-1"
  7. var _spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): BitVector.this.type

    Definition Classes
    BaseTypeDataSpinalTagReady
  9. def addAttribute(name: String, value: String): BitVector.this.type

    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String): BitVector.this.type

    Definition Classes
    SpinalTagReady
  11. def addTag[T <: SpinalTag](spinalTag: T): BitVector.this.type

    Definition Classes
    SpinalTagReady
  12. def addTags[T <: SpinalTag](tags: Iterable[T]): BitVector.this.type

    Definition Classes
    SpinalTagReady
  13. var algoIncrementale: Int

    Definition Classes
    BaseNode
  14. var algoInt: Int

    Definition Classes
    BaseNode
  15. def allowDirectionLessIo: BitVector.this.type

    Definition Classes
    Data
  16. def allowOverride: BitVector.this.type

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  17. def allowPruning(): BitVector.this.type

    Definition Classes
    Data
  18. def allowSimplifyIt(): BitVector.this.type

    Definition Classes
    BaseTypeData
  19. def allowUnsetRegToAvoidLatch: BitVector.this.type

    Definition Classes
    Data
  20. def andR: Bool

    Logical AND of all bits

  21. def apply(range: Range): BitVector.this.type

    Return a range of bits

    Return a range of bits

    Example:
    1. val myBool = myBits(3 downto 1)
  22. def asBool: Bool

  23. def asBools: Vec[Bool]

    Cast the BitVector into a Vector of Bool

    Cast the BitVector into a Vector of Bool

    returns

    a vector of Bool

  24. def asData: Data

    Definition Classes
    Data
  25. def asInOut(): BitVector.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseTypeData
  26. def asInput(): BitVector.this.type

    Set a data as input

    Set a data as input

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

    Definition Classes
    Any
  28. def asOutput(): BitVector.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  29. def assignDontCare(): BitVector.this.type

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

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

    Definition Classes
    Data
  32. def clearAll(): Unit

    Clear all bits

  33. var clockDomain: ClockDomain

    Definition Classes
    BaseType
  34. def clone(): BitVector.this.type

    Definition Classes
    BitVectorBaseTypeData → AnyRef
  35. def component: Component

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

    Definition Classes
    Assignable
  37. var compositeAssign: Assignable

    Definition Classes
    Assignable
  38. def dirString(): String

    Definition Classes
    Data
  39. def dlcAppend(that: AssignmentStatement): BitVector.this.type

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

    Definition Classes
    DoubleLinkedContainer
  41. def dlcHasOnlyOne: Boolean

    Definition Classes
    DoubleLinkedContainer
  42. var dlcHead: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer
  43. def dlcIsEmpty: Boolean

    Definition Classes
    DoubleLinkedContainer
  44. var dlcLast: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer
  45. def dlcPrepend(that: AssignmentStatement): BitVector.this.type

    Definition Classes
    DoubleLinkedContainer
  46. def dontSimplifyIt(): BitVector.this.type

    Definition Classes
    BaseTypeData
  47. final def eq(arg0: AnyRef): Boolean

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

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

    Definition Classes
    SpinalTagReady
  50. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Definition Classes
    SpinalTagReady
  51. def finalize(): Unit

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

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

    Definition Classes
    BaseTypeData
  54. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

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

    Definition Classes
    BaseTypeData
  56. def flip(): BitVector.this.type

    flip the direction of the data

    flip the direction of the data

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

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

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

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

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

  62. def genIf(cond: Boolean): BitVector.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  63. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVectorData
  64. final def getClass(): Class[_]

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

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

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  67. def getDisplayName(): String

    Definition Classes
    Nameable
  68. def getDrivingReg: BitVector.this.type

    Definition Classes
    BaseType
  69. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  70. def getName(): String

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

    Definition Classes
    Nameable
  72. def getRealSource: Any

    Definition Classes
    Assignable
  73. def getRealSourceNoRec: Any

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

    Definition Classes
    OwnableRef
  75. def getRootParent: Data

    Definition Classes
    Data
  76. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  77. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  78. def getScalaTrace(): Throwable

    Definition Classes
    ScalaLocated
  79. def getSingleDriver: Option[BitVector.this.type]

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

    Definition Classes
    SpinalTagReady
  81. def getTags(): Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  82. def getWidth: Int

    Definition Classes
    WidthableWidthProvider
  83. def getWidthNoInferation: Int

    Return the width

  84. def getWidthStringNoInferation: String

  85. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  86. def hasAssignement: Boolean

    Definition Classes
    BaseType
  87. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  88. def hasOnlyOneStatement: Boolean

  89. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Definition Classes
    SpinalTagReady
  90. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  91. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  92. def head: AssignmentStatement

  93. def high: Int

    Return the upper bound

  94. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

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

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

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

    Definition Classes
    SpinalTagReady
  98. def isAnalog: Boolean

    Definition Classes
    BaseTypeData
  99. def isComb: Boolean

    Definition Classes
    BaseTypeData
  100. def isDirectionLess: Boolean

    Definition Classes
    Data
  101. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  102. def isInOut: Boolean

    Definition Classes
    Data
  103. def isInput: Boolean

    Definition Classes
    Data
  104. def isInputOrInOut: Boolean

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

    Definition Classes
    Any
  106. def isNamed: Boolean

    Definition Classes
    Nameable
  107. def isOutput: Boolean

    Definition Classes
    Data
  108. def isOutputOrInOut: Boolean

    Definition Classes
    Data
  109. def isPriorityApplicable(namePriority: Byte): Boolean

    Definition Classes
    Nameable
  110. def isReg: Boolean

    Definition Classes
    BaseTypeData
  111. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  112. def isUnnamed: Boolean

    Definition Classes
    Nameable
  113. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  114. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  115. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  116. def keep(): BitVector.this.type

    Definition Classes
    Data
  117. var lastScopeStatement: Statement

    Definition Classes
    Statement
  118. def lsb: Bool

    Return the least significant bit

  119. def msb: Bool

    Return the most significant bit

  120. def mux[T2 <: Data](mappings: (Any, T2)*): T2

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

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

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

    Definition Classes
    AnyRef
  124. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): BitVector.this.type

    Extract a range of bits of the BitVector

  125. def newExtract(hi: Int, lo: Int, accessFactory: ⇒ BitVectorRangedAccessFixed): BitVector.this.type

    Extract a range of bits of the BitVector

  126. def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool

    Extract a bit of the BitVector

  127. def newExtract(bitId: Int, extract: BitVectorBitAccessFixed): Bool

    Extract a bit of the BitVector

  128. var nextScopeStatement: Statement

    Definition Classes
    Statement
  129. def noBackendCombMerge: BitVector.this.type

    Definition Classes
    Data
  130. def noCombLoopCheck: BitVector.this.type

    Definition Classes
    Data
  131. def normalizeInputs: Unit

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

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

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

    Definition Classes
    SpinalTagReady
  135. def orR: Bool

    Logical OR of all bits

  136. var parent: Data

    Definition Classes
    Data
  137. var parentScope: ScopeStatement

    Definition Classes
    ContextUser
  138. def pull(): BitVector.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
  139. def purify(): BitVector.this.type

    Definition Classes
    Data
  140. def randBoot(): BitVector.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
  141. def range: Range

    Return the range

  142. var refOwner: RefOwnerType

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

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

  145. def removeAssignments(): BitVector.this.type

    Remove all assignements of the base type

    Remove all assignements of the base type

    Definition Classes
    BaseTypeData
  146. def removeStatement(): Unit

    Definition Classes
    BaseTypeStatement
  147. def removeStatementFromScope(): Unit

    Definition Classes
    Statement
  148. def removeTag(spinalTag: SpinalTag): BitVector.this.type

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

    Definition Classes
    SpinalTagReady
  150. def resized: BitVector.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  151. def rootScopeStatement: ScopeStatement

    Definition Classes
    BaseTypeStatement
  152. def rotateLeft(that: UInt): T

    Left rotation of that Bits

  153. def rotateRight(that: UInt): T

    Right rotation of that Bits

  154. def setAllTo(value: Bool): Unit

    Set all bits to value

  155. def setAllTo(value: Boolean): Unit

    Set all bits to value

  156. def setAsAnalog(): BitVector.this.type

    Definition Classes
    BaseTypeData
  157. def setAsComb(): BitVector.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  158. def setAsDirectionLess(): BitVector.this.type

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

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

    Definition Classes
    BaseTypeData
  159. def setAsReg(): BitVector.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseTypeData
  160. def setAsTypeNode(): BitVector.this.type

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  161. def setAsVital(): BitVector.this.type

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  162. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BitVector.this.type

    Definition Classes
    Nameable
  163. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BitVector.this.type

    Definition Classes
    Nameable
  164. def setCompositeName(nameable: Nameable, postfix: String): BitVector.this.type

    Definition Classes
    Nameable
  165. def setCompositeName(nameable: Nameable, namePriority: Byte): BitVector.this.type

    Definition Classes
    Nameable
  166. def setCompositeName(nameable: Nameable, weak: Boolean): BitVector.this.type

    Definition Classes
    Nameable
  167. def setCompositeName(nameable: Nameable): BitVector.this.type

    Definition Classes
    Nameable
  168. def setName(name: String, namePriority: Byte): BitVector.this.type

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

    Definition Classes
    Nameable
  170. def setName(name: String): BitVector.this.type

    Definition Classes
    Nameable
  171. def setPartialName(name: String, namePriority: Byte): BitVector.this.type

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

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

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

    Definition Classes
    Nameable
  175. def setPartialName(name: String): BitVector.this.type

    Definition Classes
    Nameable
  176. def setPartialName(owner: Nameable, name: String): BitVector.this.type

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

    Definition Classes
    OwnableRef
  178. def setScalaLocated(source: ScalaLocated): BitVector.this.type

    Definition Classes
    ScalaLocated
  179. def setWeakName(name: String): BitVector.this.type

    Definition Classes
    Nameable
  180. def setWidth(width: Int): BitVector.this.type

    Set the width of the BitVector

    Set the width of the BitVector

    width

    the width of the data

    returns

    the BitVector of a given size

  181. def simplifyNode: Expression

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

    Definition Classes
    SpinalTagReady
  183. def subdivideIn(sliceWidth: BitCount): Vec[T]

    Split the BitVector into slice of x bits * @example

    Split the BitVector into slice of x bits * @example

    val res = myBits.subdiviedIn(3 bits)
    sliceWidth

    the width of the slice

    returns

    a Vector of slices

  184. def subdivideIn(sliceCount: SlicesCount): Vec[T]

    Split the BitVector into x slice

    Split the BitVector into x slice

    sliceCount

    the width of the slice

    returns

    a Vector of slices

    Example:
    1. val res = myBits.subdiviedIn(3 slices)
  185. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  186. def toString(): String

    Definition Classes
    BitVectorBaseTypeExpressionNameable → AnyRef → Any
  187. def toStringMultiLine(): String

    Definition Classes
    BaseNode
  188. def unsetName(): BitVector.this.type

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    BaseType
  199. def xorR: Bool

    Logical XOR of all bits

Deprecated Value Members

  1. def asDirectionLess(): BitVector.this.type

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    use setAsDirectionLess instead

Inherited from Widthable

Inherited from WidthProvider

Inherited from BaseType

Inherited from Expression

Inherited from DeclarationStatement

Inherited from LeafStatement

Inherited from Statement

Inherited from BaseNode

Inherited from ExpressionContainer

Inherited from Data

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped