Class

spinal.core

BitVector

Related Doc: package core

Permalink

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. 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()

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  2. abstract type T <: BitVector

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    Return the bit at index bitId

    Return the bit at index bitId

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

    Permalink

    Cast data to Bits

    Cast data to Bits

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

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

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

    Permalink
  9. abstract def getTypeObject: Any

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

    Permalink

    Create a data set to 0

    Create a data set to 0

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

    Permalink
  12. abstract def opName: String

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

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

    Permalink

    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

    Permalink
  16. abstract def rotateLeft(that: Int): T

    Permalink

    Left rotation of that bits

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

    Permalink

    Right rotation of that bits

Concrete Value Members

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

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

    Permalink

    Concatenation between two data

    Concatenation between two data

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits

    Permalink
    Definition Classes
    Data
  5. def =/=(that: MaskedLiteral): Bool

    Permalink

    BitVector is not equal to MaskedLiteral

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

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

    Permalink

    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. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String, value: String): BitVector.this.type

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  15. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  16. var algoInt: Int

    Permalink
    Definition Classes
    BaseNode
  17. def allowDirectionLessIo(): BitVector.this.type

    Permalink

    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

    Permalink

    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

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    BaseTypeData
  22. def allowUnsetRegToAvoidLatch(): BitVector.this.type

    Permalink

    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

    Permalink
  24. def andR: Bool

    Permalink

    Logical AND of all bits

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

    Permalink

    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

    Permalink
    Definition Classes
    Data
  27. def asBool: Bool

    Permalink
  28. def asBools: Vec[Bool]

    Permalink

    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

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

    Permalink

    set a data as inout

    set a data as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

    Permalink
    Definition Classes
    Data
  35. def assignDontCareToUnasigned(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  36. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    Data
  37. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit

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

    Permalink
    Definition Classes
    Data
  39. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BaseTypeAssignable
  40. def bitsRange: Range

    Permalink
  41. def cldCount: Int

    Permalink
    Definition Classes
    DoubleLinkedContainer
  42. def clearAll(): BitVector.this.type

    Permalink

    Clear all bits

    Clear all bits

    Definition Classes
    BitVectorData
  43. var clockDomain: ClockDomain

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

    Permalink
    Definition Classes
    BitVectorBaseTypeData → AnyRef
  45. def component: Component

    Permalink
    Definition Classes
    ContextUser
  46. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable
  47. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  48. def copyDirectionOfImpl(that: Data): BitVector.this.type

    Permalink
    Definition Classes
    BaseTypeData
  49. def dirString(): String

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

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

    Permalink
    Definition Classes
    DoubleLinkedContainer
  52. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  53. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  54. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  55. var dlcLast: AssignmentStatement

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

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

    Permalink
    Definition Classes
    BaseTypeData
  58. def drop(n: Int): Bits

    Permalink

    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

    Permalink

    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

    Permalink
  61. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  62. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  63. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

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

    Permalink
    Definition Classes
    SpinalTagReady
  65. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  66. def flatten: Seq[BaseType]

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

    Permalink
    Definition Classes
    BaseTypeData
  68. def flattenLocalName: Seq[String]

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

    Permalink

    flip the direction of the data

    flip the direction of the data

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

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

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

    Permalink
  73. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

    Permalink
  75. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  76. def freeze(): BitVector.this.type

    Permalink
    Definition Classes
    BaseTypeData
  77. def getAheadValue(): BitVector.this.type

    Permalink
    Definition Classes
    BaseTypeData
  78. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  80. def getComponent(): Component

    Permalink
    Definition Classes
    DataInComponentNameableByComponent
  81. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  82. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  83. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  84. def getDrivingReg(reportError: Boolean = true): BitVector.this.type

    Permalink
    Definition Classes
    BaseType
  85. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  86. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  87. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    BitVectorData
  88. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  89. def getName(): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  90. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  91. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  92. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  93. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  95. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  96. def getRtlPath(separator: String = "/"): String

    Permalink
    Definition Classes
    Data
  97. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  98. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  99. def getScalaTrace(): Throwable

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  102. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  103. def getWidth: Int

    Permalink
    Definition Classes
    WidthableWidthProvider
  104. def getWidthNoInferation: Int

    Permalink

    Return the width

  105. def getWidthStringNoInferation: String

    Permalink
  106. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  107. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  108. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  109. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  110. def hasOnlyOneStatement: Boolean

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  113. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  114. def head: AssignmentStatement

    Permalink
  115. def high: Int

    Permalink

    Return the upper bound

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

    Permalink
    Definition Classes
    Data
  117. def initialFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    BaseType
  118. def insertNext(s: Statement): Unit

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

    Permalink
    Definition Classes
    SpinalTagReady
  120. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  121. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  122. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  123. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  124. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  125. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  126. def isFrozen(): Boolean

    Permalink
    Definition Classes
    BaseType
  127. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  128. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  129. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  131. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  132. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  133. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  135. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  136. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    BitVectorData
  137. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  138. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  139. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  140. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  141. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  142. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  143. def lsb: Bool

    Permalink

    Return the least significant bit

  144. def msb: Bool

    Permalink

    Return the most significant bit

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

    Permalink
    Definition Classes
    BaseType
  146. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2

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

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

    Permalink
    Definition Classes
    BaseType
  149. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  150. var name: String

    Permalink
    Definition Classes
    Nameable
  151. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  152. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  153. def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating)(implicit loc: Location): BitVector.this.type

    Permalink

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a bit of the BitVector

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

    Permalink

    Extract a bit of the BitVector

  157. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  158. def noBackendCombMerge(): BitVector.this.type

    Permalink

    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
  159. def noCombLoopCheck(): BitVector.this.type

    Permalink

    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
  160. def normalizeInputs: Unit

    Permalink
    Definition Classes
    BaseTypeExpressionContainer
  161. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  162. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  163. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  164. def orMask(that: Bool): BitVector.this.type

    Permalink
  165. def orR: Bool

    Permalink

    Logical OR of all bits

  166. def overrideLocalName(name: String): BitVector.this.type

    Permalink
    Definition Classes
    Nameable
  167. var parent: Data

    Permalink
    Definition Classes
    Data
  168. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  169. def pull(propagateName: Boolean): BitVector.this.type

    Permalink
    Definition Classes
    Data
  170. def pull(): BitVector.this.type

    Permalink

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  171. def purify(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  172. def randBoot(u: Unit): BitVector.this.type

    Permalink

    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
  173. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  174. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  175. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

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

    Permalink
  177. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): BitVector.this.type

    Permalink

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseTypeData
  178. def removeDataAssignments(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  179. def removeInitAssignments(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  180. def removeStatement(): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  181. def removeStatementFromScope(): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  184. def resized: BitVector.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  185. def rootScopeStatement: ScopeStatement

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

    Permalink

    Left rotation of that Bits

  187. def rotateRight(that: UInt): T

    Permalink

    Right rotation of that Bits

  188. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  189. def setAll(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  190. def setAllTo(value: Bool): BitVector.this.type

    Permalink

    Set all bits to value

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

    Permalink

    Set all bits to value

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Permalink

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

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

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

    Permalink

    Set baseType to reg

    Set baseType to reg

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

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  204. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): BitVector.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  208. def setNameAsWeak(): BitVector.this.type

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  216. def setPartialName(owner: Nameable): BitVector.this.type

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

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

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

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

    Permalink

    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

  221. def simplifyNode: Expression

    Permalink
    Definition Classes
    Expression
  222. def sliceBy(divisor: List[Int]): List[Bits]

    Permalink
  223. def sliceBy(divisor: Int*): List[Bits]

    Permalink

    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))
  224. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  225. def splitAt(n: Int): (Bits, Bits)

    Permalink

    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)
  226. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

    Permalink
    Definition Classes
    ExpressionContainer
  227. def subdivideIn(sliceWidth: BitCount): Vec[T]

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

    Permalink
  229. def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]

    Permalink

    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)
  230. def subdivideIn(sliceCount: SlicesCount, strict: Boolean): Vec[T]

    Permalink

    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)
  231. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  232. def take(n: Int): Bits

    Permalink

    Take lowerst n bits

    Take lowerst n bits

    returns

    data10bits(3 downto 0)

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

    Permalink

    Take highest n bits

    Take highest n bits

    returns

    data10bits(9 downto 6)

    Example:
    1. val res = data10bits.takeHigh(4)
  234. def takeLow(n: Int): Bits

    Permalink
  235. def toIo(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  236. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data
  237. def toString(): String

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

    Permalink
    Definition Classes
    BaseNode
  239. def toStringRec(level: Int = 1): String

    Permalink
    Definition Classes
    Expression
  240. def unfreeze(): BitVector.this.type

    Permalink
    Definition Classes
    BaseTypeData
  241. def unsetName(): BitVector.this.type

    Permalink
    Definition Classes
    Nameable
  242. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  244. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    ExpressionContainer
  247. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    BaseType
  253. def wrapNext(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  254. def xorMask(that: Bool): BitVector.this.type

    Permalink
  255. def xorR: Bool

    Permalink

    Logical XOR of all bits

Deprecated Value Members

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

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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

    Permalink

    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

    Permalink

    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 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