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, InComponent, OverridedEqualsHashCode, 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. InComponent
  15. OverridedEqualsHashCode
  16. SpinalTagReady
  17. Assignable
  18. NameableByComponent
  19. Nameable
  20. OwnableRef
  21. ContextUser
  22. ScalaLocated
  23. GlobalDataUser
  24. AnyRef
  25. 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 reversed: BitVector.this.type
  16. abstract def rotateLeft(that: Int): T

    Left rotation of that bits

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

    Right rotation of that 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 #*(count: Int): Bits
    Definition Classes
    Data
  5. def =/=(that: MaskedLiteral): Bool

    BitVector is not equal to MaskedLiteral

  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. 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"
  8. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  9. def addAttribute(attribute: Attribute): BitVector.this.type
    Definition Classes
    BaseType → Data → SpinalTagReady
  10. def addAttribute(name: String, value: Int): BitVector.this.type
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String, value: String): BitVector.this.type
    Definition Classes
    SpinalTagReady
  12. def addAttribute(name: String): BitVector.this.type
    Definition Classes
    SpinalTagReady
  13. def addTag[T <: SpinalTag](spinalTag: T): BitVector.this.type
    Definition Classes
    SpinalTagReady
  14. def addTags[T <: SpinalTag](tags: Iterable[T]): BitVector.this.type
    Definition Classes
    SpinalTagReady
  15. val algoIncrementale: Int
    Definition Classes
    BaseNode
  16. val algoInt: Int
    Definition Classes
    BaseNode
  17. def allowDirectionLessIo(): BitVector.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

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

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  19. def allowPartialyAssigned(): BitVector.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  20. def allowPruning(): BitVector.this.type
    Definition Classes
    Data
  21. def allowSimplifyIt(): BitVector.this.type
    Definition Classes
    BaseType → Data
  22. def allowUnsetRegToAvoidLatch(): BitVector.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  23. def andMask(that: Bool): BitVector.this.type
  24. def andR: Bool

    Logical AND of all bits

  25. 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)
  26. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  27. def asBool: Bool
  28. 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

  29. def asData: Data
    Definition Classes
    Data
  30. def asInOut(): BitVector.this.type

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

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

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  34. def assignDontCare(): BitVector.this.type
    Definition Classes
    Data
  35. def assignDontCareToUnasigned(): BitVector.this.type
    Definition Classes
    Data
  36. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    Data
  37. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  38. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  39. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    BaseType → Assignable
  40. def bitsRange: Range
  41. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  42. def clearAll(): BitVector.this.type

    Clear all bits

    Clear all bits

    Definition Classes
    BitVector → Data
  43. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  44. def clone(): BitVector.this.type
    Definition Classes
    BitVector → BaseType → Data → AnyRef
  45. def component: Component
    Definition Classes
    ContextUser
  46. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  47. val compositeAssign: Assignable
    Definition Classes
    Assignable
  48. def copyDirectionOfImpl(that: Data): BitVector.this.type
    Definition Classes
    BaseType → Data
  49. def dirString(): String
    Definition Classes
    Data
  50. def dlcAppend(that: AssignmentStatement): BitVector.this.type
    Definition Classes
    DoubleLinkedContainer
  51. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  52. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  53. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  54. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  55. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  56. def dlcPrepend(that: AssignmentStatement): BitVector.this.type
    Definition Classes
    DoubleLinkedContainer
  57. def dontSimplifyIt(): BitVector.this.type
    Definition Classes
    BaseType → Data
  58. def drop(n: Int): Bits

    Drop lowerst n bits

    Drop lowerst n bits

    returns

    data10bits(9 downto 4)

    Example: 

    1. val res = data10bits.drop(4)
  59. def dropHigh(n: Int): Bits

    Drop highest n bits

    Drop highest n bits

    returns

    data10bits(5 downto 0)

    Example: 

    1. val res = data10bits.dropHigh(4)
  60. def dropLow(n: Int): Bits
  61. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  63. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  64. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  65. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  66. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  67. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    BaseType → Data
  68. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  69. def flip(): BitVector.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  70. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit
    Definition Classes
    BaseType → Statement
  71. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  72. def foreachExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  73. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  74. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  75. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  76. def freeze(): BitVector.this.type
    Definition Classes
    BaseType → Data
  77. def getAheadValue(): BitVector.this.type
    Definition Classes
    BaseType → Data
  78. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    BitVector → Data
  79. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  80. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  81. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  82. def getDirection: IODirection
    Definition Classes
    Data
  83. def getDisplayName(): String
    Definition Classes
    Nameable
  84. def getDrivingReg(reportError: Boolean = true): BitVector.this.type
    Definition Classes
    BaseType
  85. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  86. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  87. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    BitVector → Data
  88. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  89. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  90. def getPartialName(): String
    Definition Classes
    Nameable
  91. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  92. def getRealSource: Any
    Definition Classes
    Assignable
  93. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  94. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  95. def getRootParent: Data
    Definition Classes
    Data
  96. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  97. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  98. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  99. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  100. def getSingleDriver: Option[BitVector.this.type]
    Definition Classes
    BaseType
  101. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  102. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  103. def getWidth: Int
    Definition Classes
    Widthable → WidthProvider
  104. def getWidthNoInferation: Int

    Return the width

  105. def getWidthStringNoInferation: String
  106. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  107. def hasAssignement: Boolean
    Definition Classes
    BaseType
  108. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  109. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  110. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  111. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  112. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  113. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  114. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  115. def high: Int

    Return the upper bound

  116. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  117. def initialFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    BaseType
  118. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  119. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  120. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  121. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  122. def isComb: Boolean
    Definition Classes
    BaseType → Data
  123. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  124. def isDirectionLess: Boolean
    Definition Classes
    Data
  125. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  126. def isFrozen(): Boolean
    Definition Classes
    BaseType
  127. def isInOut: Boolean
    Definition Classes
    Data
  128. def isInput: Boolean
    Definition Classes
    Data
  129. def isInputOrInOut: Boolean
    Definition Classes
    Data
  130. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  131. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  132. def isOutput: Boolean
    Definition Classes
    Data
  133. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  134. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  135. def isReg: Boolean
    Definition Classes
    BaseType → Data
  136. def isRegOnAssign: Boolean
    Definition Classes
    BitVector → Data
  137. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  138. def isUnknown: Bool
  139. def isUnnamed: Boolean
    Definition Classes
    Nameable
  140. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  141. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  142. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  143. val lastScopeStatement: Statement
    Definition Classes
    Statement
  144. def lsb: Bool

    Return the least significant bit

  145. def msb: Bool

    Return the most significant bit

  146. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  147. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  148. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  149. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  150. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  151. val name: String
    Definition Classes
    Nameable
  152. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  153. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  154. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating)(implicit loc: Location): BitVector.this.type

    Extract a range of bits of the BitVector

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

    Extract a range of bits of the BitVector

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

    Extract a bit of the BitVector

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

    Extract a bit of the BitVector

  158. val nextScopeStatement: Statement
    Definition Classes
    Statement
  159. def noBackendCombMerge(): BitVector.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  160. def noCombLoopCheck(): BitVector.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  161. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  162. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  163. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  164. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  165. def orMask(that: Bool): BitVector.this.type
  166. def orR: Bool

    Logical OR of all bits

  167. def overrideLocalName(name: String): BitVector.this.type
    Definition Classes
    Nameable
  168. val parent: Data
    Definition Classes
    Data
  169. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  170. def pull(propagateName: Boolean): BitVector.this.type
    Definition Classes
    Data
  171. 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
  172. def purify(): BitVector.this.type
    Definition Classes
    Data
  173. def randBoot(u: Unit): BitVector.this.type

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  174. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  175. def reflectNames(): Unit
    Definition Classes
    Nameable
  176. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  177. def remapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  178. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): BitVector.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  179. def removeDataAssignments(): BitVector.this.type
    Definition Classes
    Data
  180. def removeInitAssignments(): BitVector.this.type
    Definition Classes
    Data
  181. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  182. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  183. def removeTag(spinalTag: SpinalTag): BitVector.this.type
    Definition Classes
    SpinalTagReady
  184. def removeTags(tags: Iterable[SpinalTag]): BitVector.this.type
    Definition Classes
    SpinalTagReady
  185. def resized: BitVector.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  186. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  187. def rootIFList(): List[Interface]
    Definition Classes
    Data
  188. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  189. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  190. def rotateLeft(that: UInt): T

    Left rotation of that Bits

  191. def rotateRight(that: UInt): T

    Right rotation of that Bits

  192. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  193. def setAll(): BitVector.this.type
    Definition Classes
    Data
  194. def setAllTo(value: Bool): BitVector.this.type

    Set all bits to value

  195. def setAllTo(value: Boolean): BitVector.this.type

    Set all bits to value

  196. def setAsAnalog(): BitVector.this.type
    Definition Classes
    BaseType → Data
  197. def setAsComb(): BitVector.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  198. 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
    BaseType → Data
  199. def setAsReg(): BitVector.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType → Data
  200. def setAsTypeNode(): BitVector.this.type

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  202. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BitVector.this.type
    Definition Classes
    Nameable
  203. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  204. def setCompositeName(nameable: Nameable, postfix: String): BitVector.this.type
    Definition Classes
    Nameable
  205. def setCompositeName(nameable: Nameable, namePriority: Byte): BitVector.this.type
    Definition Classes
    Nameable
  206. def setCompositeName(nameable: Nameable, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  207. def setCompositeName(nameable: Nameable): BitVector.this.type
    Definition Classes
    Nameable
  208. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): BitVector.this.type
    Definition Classes
    Nameable
  209. def setName(name: String, namePriority: Byte): BitVector.this.type
    Definition Classes
    Nameable
  210. def setName(name: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  211. def setName(name: String): BitVector.this.type
    Definition Classes
    Nameable
  212. def setNameAsWeak(): BitVector.this.type
    Definition Classes
    Nameable
  213. def setOutputAsReg(): BitVector.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  214. def setPartialName(name: String, namePriority: Byte, owner: Any): BitVector.this.type
    Definition Classes
    Nameable
  215. def setPartialName(name: String, namePriority: Byte): BitVector.this.type
    Definition Classes
    Nameable
  216. def setPartialName(name: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  217. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BitVector.this.type
    Definition Classes
    Nameable
  218. def setPartialName(owner: Nameable, name: String, weak: Boolean): BitVector.this.type
    Definition Classes
    Nameable
  219. def setPartialName(name: String): BitVector.this.type
    Definition Classes
    Nameable
  220. def setPartialName(owner: Nameable, name: String): BitVector.this.type
    Definition Classes
    Nameable
  221. def setPartialName(owner: Nameable): BitVector.this.type
    Definition Classes
    Nameable
  222. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  223. def setScalaLocated(source: ScalaLocated): BitVector.this.type
    Definition Classes
    ScalaLocated
  224. def setWeakName(name: String): BitVector.this.type
    Definition Classes
    Nameable
  225. 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

  226. def simplifyNode: Expression
    Definition Classes
    Expression
  227. def sliceBy(divisor: List[Int]): List[Bits]
  228. def sliceBy(divisor: Int*): List[Bits]

    apart by a list of width

    apart by a list of width

    returns

    (List(A(1 downto 0), A(2 downto 4), A(9 downto 3))

    Example: 

    1. val res = A.sliceBy(2, 3, 5)
val res = A.sliceBy(List(2, 3, 5))
  229. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  230. def splitAt(n: Int): (Bits, Bits)

    Split at n st bits

    Split at n st bits

    returns

    (data10bits(8 downto 4), data10bits(3 downto 0))

    Example: 

    1. val res = data10bits.splitAt(4)
  231. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  232. def subdivideIn(sliceWidth: BitCount): Vec[T]
  233. def subdivideIn(sliceCount: SlicesCount): Vec[T]
  234. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

    Split the BitVector into slice of x bits

    Split the BitVector into slice of x bits

    sliceWidth

    the width of the slice

    strict

    allow subdivideIn to generate vectors with varying size

    returns

    a Vector of slices

    Example: 

    1. val res = myBits.subdivideIn(3 bits)
  235. def subdivideIn(sliceCount: SlicesCount, strict: Boolean): Vec[T]

    Split the BitVector into x slice

    Split the BitVector into x slice

    sliceCount

    the width of the slice

    strict

    allow subdivideIn to generate vectors with varying size

    returns

    a Vector of slices

    Example: 

    1. val res = myBits.subdivideIn(3 slices)
  236. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  237. def take(n: Int): Bits

    Take lowerst n bits

    Take lowerst n bits

    returns

    data10bits(3 downto 0)

    Example: 

    1. val res = data10bits.take(4)
  238. def takeHigh(n: Int): Bits

    Take highest n bits

    Take highest n bits

    returns

    data10bits(9 downto 6)

    Example: 

    1. val res = data10bits.takeHigh(4)
  239. def takeLow(n: Int): Bits
  240. def toIo(): BitVector.this.type
    Definition Classes
    Data
  241. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  242. def toString(): String
    Definition Classes
    BitVector → BaseType → Expression → Nameable → AnyRef → Any
  243. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  244. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  245. def unfreeze(): BitVector.this.type
    Definition Classes
    BaseType → Data
  246. def unsetName(): BitVector.this.type
    Definition Classes
    Nameable
  247. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  248. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  249. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  250. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  251. def walkExpression(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  252. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit
    Definition Classes
    ExpressionContainer
  253. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  254. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit
    Definition Classes
    Statement
  255. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  256. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit
    Definition Classes
    ExpressionContainer
  257. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  258. def wrapNext(): BitVector.this.type
    Definition Classes
    Data
  259. def xorMask(that: Bool): BitVector.this.type
  260. def xorR: Bool

    Logical XOR of all bits

Deprecated Value Members

  1. def asDirectionLess(): BitVector.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  3. def genIf(cond: Boolean): BitVector.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

  4. def range: Range

    Return the range

    Return the range

    Annotations
    @deprecated
    Deprecated

    Use bitsRange instead

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 InComponent

Inherited from OverridedEqualsHashCode

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