Packages

c

spinal.core

BitVector

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:

  • Bits
  • UInt (unsigned integer)
  • SInt (signed integer)
See also

BitVector Documentation

Linear Supertypes
Widthable, WidthProvider, BaseType, Expression, StatementDoubleLinkedContainer[BaseType, AssignmentStatement], DoubleLinkedContainer[BaseType, AssignmentStatement], DeclarationStatement, LeafStatement, Statement, BaseNode, ExpressionContainer, Data, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Known Subclasses
Bits, SInt, UInt
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
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. val _spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): BitVector.this.type
    Definition Classes
    BaseType → Data → SpinalTagReady
  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(spinalTag: SpinalTag): BitVector.this.type
    Definition Classes
    SpinalTagReady
  12. def addTags(tags: Iterable[SpinalTag]): BitVector.this.type
    Definition Classes
    SpinalTagReady
  13. val algoIncrementale: Int
    Definition Classes
    BaseNode
  14. val 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
    BaseType → Data
  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 asDirectionLess(): BitVector.this.type

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

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

    Definition Classes
    BaseType → Data
  26. def asInOut(): BitVector.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseType → Data
  27. def asInput(): BitVector.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    BaseType → Data
  28. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  29. def asOutput(): BitVector.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  30. def assignDontCare(): BitVector.this.type
    Definition Classes
    Data
  31. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  32. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  33. def clearAll(): Unit

    Clear all bits

  34. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  35. def clone(): BitVector.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  36. def component: Component
    Definition Classes
    ContextUser
  37. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  38. val compositeAssign: Assignable
    Definition Classes
    Assignable
  39. def dirString(): String
    Definition Classes
    Data
  40. def dlcAppend(that: AssignmentStatement): BitVector.this.type
    Definition Classes
    DoubleLinkedContainer
  41. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  42. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  43. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  44. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  45. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  46. def dlcPrepend(that: AssignmentStatement): BitVector.this.type
    Definition Classes
    DoubleLinkedContainer
  47. def dontSimplifyIt(): BitVector.this.type
    Definition Classes
    BaseType → Data
  48. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  50. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  51. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  52. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  53. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  54. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  55. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    BaseType → Data
  56. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  57. def flip(): BitVector.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  58. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit
    Definition Classes
    BaseType → Statement
  59. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  60. def foreachExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  61. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  62. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  63. def genIf(cond: Boolean): BitVector.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  64. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVector → Data
  65. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  66. def getComponent(): Component
    Definition Classes
    Data → NameableByComponent
  67. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  68. def getDisplayName(): String
    Definition Classes
    Nameable
  69. def getDrivingReg: BitVector.this.type
    Definition Classes
    BaseType
  70. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  71. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  72. def getName(default: String): String
    Definition Classes
    Nameable
  73. def getRealSource: Any
    Definition Classes
    Assignable
  74. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  75. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  76. def getRootParent: Data
    Definition Classes
    Data
  77. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  78. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  79. def getScalaTrace(): Throwable
    Definition Classes
    ContextUser → ScalaLocated
  80. def getSingleDriver: Option[BitVector.this.type]
    Definition Classes
    BaseType
  81. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  82. def getWidth: Int
    Definition Classes
    Widthable → WidthProvider
  83. def getWidthNoInferation: Int

    Return the width

  84. def getWidthStringNoInferation: String
  85. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  86. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  87. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  88. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  89. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  90. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  91. def high: Int

    Return the upper bound

  92. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  93. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  94. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  95. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  96. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  97. def isComb: Boolean
    Definition Classes
    BaseType → Data
  98. def isDirectionLess: Boolean
    Definition Classes
    Data
  99. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  100. def isInOut: Boolean
    Definition Classes
    Data
  101. def isInput: Boolean
    Definition Classes
    Data
  102. def isInputOrInOut: Boolean
    Definition Classes
    Data
  103. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  104. def isNamed: Boolean
    Definition Classes
    Nameable
  105. def isOutput: Boolean
    Definition Classes
    Data
  106. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  107. def isReg: Boolean
    Definition Classes
    BaseType → Data
  108. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  109. def isUnnamed: Boolean
    Definition Classes
    Nameable
  110. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  111. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  112. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  113. def keep(): BitVector.this.type
    Definition Classes
    Data
  114. val lastScopeStatement: Statement
    Definition Classes
    Statement
  115. def lsb: Bool

    Return the least significant bit

  116. def msb: Bool

    Return the most significant bit

  117. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  118. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  119. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  120. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  121. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): BitVector.this.type

    Extract a range of bits of the BitVector

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

    Extract a range of bits of the BitVector

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

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

  125. val nextScopeStatement: Statement
    Definition Classes
    Statement
  126. def noBackendCombMerge: BitVector.this.type
    Definition Classes
    Data
  127. def noCombLoopCheck: BitVector.this.type
    Definition Classes
    Data
  128. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  129. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  130. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  131. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  132. def orR: Bool

    Logical OR of all bits

  133. val parent: Data
    Definition Classes
    Data
  134. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  135. 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
  136. 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
  137. def range: Range

    Return the range

  138. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @dontName()
  139. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  140. def remapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  141. def removeAssignments(): BitVector.this.type

    Remove all assignements of the base type

    Remove all assignements of the base type

    Definition Classes
    BaseType → Data
  142. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  143. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  144. def removeTag(spinalTag: SpinalTag): BitVector.this.type
    Definition Classes
    SpinalTagReady
  145. def removeTags(tags: Iterable[SpinalTag]): BitVector.this.type
    Definition Classes
    SpinalTagReady
  146. def resized: BitVector.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  147. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  148. def rotateLeft(that: UInt): T

    Left rotation of that Bits

  149. def rotateRight(that: UInt): T

    Right rotation of that Bits

  150. def setAllTo(value: Bool): Unit

    Set all bits to value

  151. def setAllTo(value: Boolean): Unit

    Set all bits to value

  152. def setAsAnalog(): BitVector.this.type
    Definition Classes
    BaseType → Data
  153. def setAsComb(): BitVector.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType
  154. def setAsReg(): BitVector.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType
  155. def setAsTypeNode(): BitVector.this.type

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  157. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  158. def setCompositeName(nameable: Nameable, postfix: String): BitVector.this.type
    Definition Classes
    Nameable
  159. def setCompositeName(nameable: Nameable, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  160. def setCompositeName(nameable: Nameable): BitVector.this.type
    Definition Classes
    Nameable
  161. def setName(name: String, weak: Boolean = false): BitVector.this.type
    Definition Classes
    Nameable
  162. def setPartialName(name: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  163. def setPartialName(owner: Nameable, name: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  164. def setPartialName(name: String): BitVector.this.type
    Definition Classes
    Nameable
  165. def setPartialName(owner: Nameable, name: String): BitVector.this.type
    Definition Classes
    Nameable
  166. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  167. def setScalaLocated(source: ScalaLocated): BitVector.this.type
    Definition Classes
    ScalaLocated
  168. def setWeakName(name: String): BitVector.this.type
    Definition Classes
    Nameable
  169. 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

  170. def simplifyNode: Expression
    Definition Classes
    Expression
  171. def spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  172. 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

  173. 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)
  174. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  175. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  176. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  177. def unsetName(): BitVector.this.type
    Definition Classes
    Nameable
  178. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  179. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  180. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  181. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  182. def walkExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  183. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  184. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  185. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  186. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  187. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  188. def xorR: Bool

    Logical XOR of all bits

Inherited from Widthable

Inherited from WidthProvider

Inherited from BaseType

Inherited from Expression

Inherited from StatementDoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DoubleLinkedContainer[BaseType, AssignmentStatement]

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