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

See also

BitVector family 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 signal to Bits

    Cast signal 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 signal set to 0

    Create a signal 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 signals

    Concatenation between two signals

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

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

    Permalink

    Return the count time concatenation of the signal.

    Return the count time concatenation of the signal.

    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. def IFparent: Data

    Permalink
    Definition Classes
    Data
  9. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  15. def addTags(h: SpinalTag, tail: SpinalTag*): BitVector.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  17. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  18. var algoInt: Int

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

    Permalink

    Allow a signal of an io Bundle to be directionless.

    Allow a signal of an io Bundle to be directionless.

    Definition Classes
    Data
    See also

    IO Bundle Error Documentation

  20. def allowOverride(): BitVector.this.type

    Permalink

    Allow a signal to be overridden.

    Allow a signal to be overridden.

    Definition Classes
    Data
    See also

    Assignment overlap Error Documentation

  21. def allowPartialyAssigned(): BitVector.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    BaseTypeData
  24. 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)

    Definition Classes
    Data
    See also

    "Register with only init" Error Documentation

  25. def andMask(that: Bool): BitVector.this.type

    Permalink
  26. def andR: Bool

    Permalink

    Hardware logical AND of all bits

    Hardware logical AND of all bits

    Equivalent to this.asBits === ((BigInt(1) << getWidth) - 1).

  27. 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)
  28. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  29. def asBool: Bool

    Permalink

    Return this.lsb

  30. def asBools: Vec[Bool]

    Permalink

    Cast the BitVector into a vector of Bool

  31. def asData: Data

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

    Permalink

    Set a signal as inout

    Set a signal as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

    Permalink

    Assign the default 'x' value to all signals composing this type.

    Assign the default 'x' value to all signals composing this type.

    Definition Classes
    Data
    See also

    "Don't care term" wikipedia article

    Data type documentation

  37. def assignDontCareToUnasigned(): BitVector.this.type

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

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

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

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

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

    Permalink
  43. def cldCount: Int

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

    Permalink

    Clear all bits

    Clear all bits

    Definition Classes
    BitVectorData
  45. var clockDomain: ClockDomain

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

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

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

    Permalink
    Definition Classes
    Assignable
  49. var compositeAssign: Assignable

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

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

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

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

    Permalink
    Definition Classes
    DoubleLinkedContainer
  54. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  55. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  56. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  57. var dlcLast: AssignmentStatement

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

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

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

    Permalink

    Drop lowest n bits

    Drop lowest n bits

    returns

    data10bits(9 downto 4)

    Example:
    1. val res = data10bits.drop(4)
  61. 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)
  62. def dropLow(n: Int): Bits

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

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

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

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

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

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

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

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

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

    Permalink

    Flip the direction of the signal.

    Flip the direction of the signal.

    in and out are swapped, inout stay the same.

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

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

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

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

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

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

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

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

    Permalink

    For a register, get the value it will have at the next clock, as a combinational signal.

    For a register, get the value it will have at the next clock, as a combinational signal.

    Definition Classes
    BaseTypeData
  80. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  84. def getDirection: IODirection

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

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

    Permalink
    Definition Classes
    BaseType
  87. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  88. def getMode: Byte

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

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

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  94. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  95. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  97. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  99. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  100. def getScalaLocationShort: String

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  105. def getTagsOf[T <: SpinalTag]()(implicit tag: ClassTag[T]): Iterable[T]

    Permalink
    Definition Classes
    SpinalTagReady
  106. def getWidth: Int

    Permalink
    Definition Classes
    WidthableWidthProvider
  107. def getWidthNoInferation: Int

    Permalink

    Return the width

  108. def getWidthStringNoInferation: String

    Permalink
  109. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  110. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  111. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  112. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  113. def hasOnlyOneStatement: Boolean

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

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

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

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

    Permalink
  118. def high: Int

    Permalink

    Return the upper bound

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  124. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  125. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  126. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  127. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  128. def isEmptyOfTag: Boolean

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

    Permalink
    Definition Classes
    BaseType
  130. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  131. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  132. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  134. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  135. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  136. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  138. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  139. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    BitVectorData
  140. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  141. def isUnknown: Bool

    Permalink
  142. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  143. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  144. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  145. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  146. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  147. def lsb: Bool

    Permalink

    Return the least significant bit

  148. def msb: Bool

    Permalink

    Return the most significant bit

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

    Permalink

    Use a SpinalHDL data as a selector for a mux.

    Use a SpinalHDL data as a selector for a mux.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  150. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2

    Permalink

    Version of SpinalHDL mux that allows Don't Care.

    Version of SpinalHDL mux that allows Don't Care.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  151. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Permalink

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  152. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  153. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink

    Version of SpinalHDL muxList that allows Don't Care.

    Version of SpinalHDL muxList that allows Don't Care.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  154. var name: String

    Permalink
    Definition Classes
    Nameable
  155. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  156. def nandR: Bool

    Permalink

    Hardware logical NAND of all bits

  157. final def ne(arg0: AnyRef): Boolean

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

    Permalink

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a range of bits of the BitVector

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

    Permalink

    Extract a bit of the BitVector

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

    Permalink

    Extract a bit of the BitVector

  162. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  163. 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
  164. def noCombLoopCheck(): BitVector.this.type

    Permalink

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    Definition Classes
    Data
    See also

    Combinatorial loop Error Documentation

  165. def norR: Bool

    Permalink

    Hardware logical NOR of all bits

  166. def normalizeInputs: Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  169. def nxorR: Bool

    Permalink

    Hardware logical NXOR of all bits

  170. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

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

    Permalink
  172. def orR: Bool

    Permalink

    Hardware logical OR of all bits

    Hardware logical OR of all bits

    Equivalent to this.asBits =/= 0.

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

    Permalink
    Definition Classes
    Nameable
  174. var parent: Data

    Permalink
    Definition Classes
    Data
  175. var parentScope: ScopeStatement

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

    Permalink
    Definition Classes
    Data
  177. 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
  178. def purify(): BitVector.this.type

    Permalink
    Definition Classes
    Data
  179. 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
  180. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  182. def remapClockDomain(func: (ClockDomain) ⇒ ClockDomain): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  183. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

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

    Permalink
  185. 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
  186. def removeDataAssignments(): BitVector.this.type

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

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

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

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

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

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

    Permalink

    Return a version of the signal which is allowed to be automatically resized where needed.

    Return a version of the signal which is allowed to be automatically resized where needed.

    The resize operation is deferred until the point of assignment later. The resize may widen or truncate, retaining the LSB.

    Definition Classes
    Data
    See also

    Width checking Documentation

  193. def rootIF(): Interface

    Permalink

    root interface

    root interface

    Definition Classes
    Data
  194. def rootIFList(): List[Interface]

    Permalink
    Definition Classes
    Data
  195. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]

    Permalink
    Definition Classes
    Data
  196. def rootScopeStatement: ScopeStatement

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

    Permalink

    Left rotation of that Bits

  198. def rotateRight(that: UInt): T

    Permalink

    Right rotation of that Bits

  199. var scalaTrace: Throwable

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

    Permalink

    Set all bits to True and return itself

    Set all bits to True and return itself

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

    Permalink

    Set all bits to value

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

    Permalink

    Set all bits to value

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Permalink

    Remove the direction (in, out, inout) to a signal

    Remove the direction (in, out, inout) to a signal

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

    Permalink

    Set baseType to reg

    Set baseType to reg

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

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  220. def setOutputAsReg(): BitVector.this.type

    Permalink

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  221. def setPartialName(name: String, namePriority: Byte, owner: Any): BitVector.this.type

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  232. 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

  233. def simplifyNode: Expression

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  237. 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)
  238. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

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

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

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

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

    Permalink

    Take lowest n bits

    Take lowest n bits

    returns

    data10bits(3 downto 0)

    Example:
    1. val res = data10bits.take(4)
  245. 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)
  246. def takeLow(n: Int): Bits

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  267. def xorR: Bool

    Permalink

    Hardware logical XOR of all bits

    Hardware logical XOR of all bits

    Equivalent to this.asBools.reduce(_ ^ _).

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