class SInt extends BitVector with Num[SInt] with MinMaxProvider with DataPrimitives[SInt] with BaseTypePrimitives[SInt] with BitwiseOp[SInt]
The SInt type corresponds to a vector of bits that can be used for signed integer arithmetic.
val mySInt = SInt(8 bits) mySInt := S(4, 8 bits) + S"0000_1111" mySInt := S(4) - S"h1A"
- See also
- Alphabetic
- By Inheritance
- SInt
- BitwiseOp
- BaseTypePrimitives
- DataPrimitives
- MinMaxProvider
- Num
- BitVector
- Widthable
- WidthProvider
- BaseType
- Expression
- StatementDoubleLinkedContainer
- DoubleLinkedContainer
- DeclarationStatement
- LeafStatement
- Statement
- BaseNode
- ExpressionContainer
- Data
- InComponent
- OverridedEqualsHashCode
- SpinalTagReady
- Assignable
- NameableByComponent
- Nameable
- OwnableRef
- ContextUser
- ScalaLocated
- GlobalDataUser
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SInt()
Type Members
- abstract type RefOwnerType
- Definition Classes
- OwnableRef
- type T = SInt
Used to know the data type of the children class of BitVector
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ##(right: Data): Bits
Concatenation between two data
Concatenation between two data
- Definition Classes
- Data
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def %(right: SInt): SInt
Modulo
- def &(right: SInt): SInt
Logical AND operator
- def *(right: SInt): SInt
Multiplication
- def +(right: SInt): SInt
Addition
- def +^(right: SInt): SInt
Safe Addition with 1 bit expand
- def +|(right: SInt): SInt
Safe Addition with saturation
- def -(right: SInt): SInt
Substraction
- def -^(right: SInt): SInt
Safe Substraction with 1 bit expand
- def -|(right: SInt): SInt
Safe Substraction with saturation
- def /(right: SInt): SInt
Division
- def :=(value: String): Unit
- def :=(rangesValue: (Any, Any), _rangesValues: (Any, Any)*): Unit
Assign a range value to a SInt
Assign a range value to a SInt
- rangesValue
The first range value
- _rangesValues
Others range values
core.io.interrupt = (0 -> uartCtrl.io.interrupt, 1 -> timerCtrl.io.interrupt, default -> false)
Example: - def :=(that: SInt): Unit
Assign a data to this
Assign a data to this
- Definition Classes
- DataPrimitives
- def <(right: SInt): Bool
Is less than right
- def <<(that: UInt): SInt
Logical shift Left (output width will increase of : w(this) + max(that) bits
- def <<(that: Int): SInt
Logical left shift (w(T) = w(this) + shift)
- def <=(right: SInt): Bool
Is equal or less than right
- def <>(that: SInt): Unit
Auto connection between two data
Auto connection between two data
- Definition Classes
- DataPrimitives
- def =/=(that: SInt): Bool
- Definition Classes
- DataPrimitives
- def =/=(that: MaskedLiteral): Bool
BitVector is not equal to MaskedLiteral
BitVector is not equal to MaskedLiteral
- Definition Classes
- BitVector
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===(that: SInt): Bool
Comparison between two data
Comparison between two data
- Definition Classes
- DataPrimitives
- 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
- Definition Classes
- BitVector
val myBool = myBits === M"0-1"
Example: - def >(right: SInt): Bool
Is greater than right
- def >=(right: SInt): Bool
Is equal or greater than right
- def >>(that: UInt): SInt
Logical shift Right (output width == input width)
Logical shift Right (output width == input width)
- that
the number of right shift
- returns
a Bits of width : w(this)
val result = mySInt >> myUIntShift
Example: - def >>(that: Int): SInt
Logical right shift (w(T) = w(this) - shift)
- def @@(that: Bool): SInt
Concatenation between a SInt and a Bool
- def @@(that: UInt): SInt
Concatenation between a SInt and UInt
- def @@(that: SInt): SInt
Concatenation between two SInt
Concatenation between two SInt
- that
an SInt to append
- returns
a new SInt of width (width(this) + width(right))
val mySInt = sInt1 @@ sInt2
Example: - def Q: QFormat
- Definition Classes
- Num
- def \(that: SInt): SInt
Use as \= to have the same behavioral as VHDL variable
Use as \= to have the same behavioral as VHDL variable
- Definition Classes
- DataPrimitives
- def ^(right: SInt): SInt
Logical XOR operator
- def _fixEntry(roundN: Int, roundType: RoundType, satN: Int): SInt
- Attributes
- protected
- val _spinalTags: LinkedHashSet[SpinalTag]
- Definition Classes
- SpinalTagReady
- def addAttribute(attribute: Attribute): SInt.this.type
- Definition Classes
- BaseType → Data → SpinalTagReady
- def addAttribute(name: String, value: Int): SInt.this.type
- Definition Classes
- SpinalTagReady
- def addAttribute(name: String, value: String): SInt.this.type
- Definition Classes
- SpinalTagReady
- def addAttribute(name: String): SInt.this.type
- Definition Classes
- SpinalTagReady
- def addTag[T <: SpinalTag](spinalTag: T): SInt.this.type
- Definition Classes
- SpinalTagReady
- def addTags[T <: SpinalTag](tags: Iterable[T]): SInt.this.type
- Definition Classes
- SpinalTagReady
- val algoIncrementale: Int
- Definition Classes
- BaseNode
- val algoInt: Int
- Definition Classes
- BaseNode
- def allowDirectionLessIo: SInt.this.type
- Definition Classes
- Data
- def allowOverride: SInt.this.type
Allow a data to be overrided
Allow a data to be overrided
- Definition Classes
- Data
- def allowPartialyAssigned: SInt.this.type
- Definition Classes
- Data
- def allowPruning(): SInt.this.type
- Definition Classes
- Data
- def allowSimplifyIt(): SInt.this.type
- def allowUnsetRegToAvoidLatch: SInt.this.type
- Definition Classes
- Data
- def andMask(that: Bool): SInt.this.type
- Definition Classes
- BitVector
- def andR: Bool
Logical AND of all bits
Logical AND of all bits
- Definition Classes
- BitVector
- def apply(offset: UInt, bitCount: BitCount): SInt.this.type
Return a range of bits at offset and of width bitCount
- def apply(offset: Int, bitCount: BitCount): SInt.this.type
Return a range of bits at offset and of width bitCount
- def apply(bitId: UInt): Bool
Return the bit at index bitId
- def apply(bitId: Int): Bool
Return the bit at index bitId
- def apply(range: Range): SInt.this.type
Return a range of bits
Return a range of bits
- Definition Classes
- BitVector
val myBool = myBits(3 downto 1)
Example: - def as[T <: Data](dataType: HardType[T]): T
- Definition Classes
- Data
- def asBits: Bits
Cast data to Bits
- def asBool: Bool
- Definition Classes
- BitVector
- def asBools: Vec[Bool]
Cast the BitVector into a Vector of Bool
- def asData: Data
- Definition Classes
- Data
- def asInOut(): SInt.this.type
set a data as inout
- def asInput(): SInt.this.type
Set a data as input
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asOutput(): SInt.this.type
Set a data as output
- def asUInt: UInt
Cast a SInt into an UInt
Cast a SInt into an UInt
- returns
a UInt data
myUInt := mySInt.asUInt
Example: - def assignDontCare(): SInt.this.type
- def assignFormalRandom(kind: RandomExpKind): Unit
- final def assignFrom(that: AnyRef, target: AnyRef = this): Unit
- Definition Classes
- Data
- def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
- def assignFromBits(bits: Bits): Unit
- def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
- Definition Classes
- Data
- def bitsRange: Range
- Definition Classes
- BitVector
- def ceil(n: Int, align: Boolean = true): SInt
SInt ceil
- def ceil(width: BitCount, align: Boolean): SInt
lowest n bits Round Operation by BitCount
lowest n bits Round Operation by BitCount
- Definition Classes
- Num
- def ceilToInf(n: Int, align: Boolean = true): SInt
SInt roundUp lowest m bits, friendly for hardware timing and area sign * ceil(abs(x))
- def ceilToInf(width: BitCount, align: Boolean): SInt
- Definition Classes
- Num
- def cldCount: Int
- Definition Classes
- DoubleLinkedContainer
- def clearAll(): SInt.this.type
Clear all bits
Clear all bits
- Definition Classes
- BitVector
- var clockDomain: ClockDomain
- Definition Classes
- BaseType
- def clone(): SInt.this.type
- def component: Component
- Definition Classes
- ContextUser
- final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
- Definition Classes
- Assignable
- val compositeAssign: Assignable
- Definition Classes
- Assignable
- def copyDirectionOf(that: SInt): Unit
- Definition Classes
- DataPrimitives
- def copyDirectionOfImpl(that: Data): SInt.this.type
- def default(that: => SInt): SInt
Set a default value to a data
Set a default value to a data
- Definition Classes
- DataPrimitives
- def dirString(): String
- Definition Classes
- Data
- def dlcAppend(that: AssignmentStatement): SInt.this.type
- Definition Classes
- DoubleLinkedContainer
- def dlcForeach[T >: AssignmentStatement](func: (T) => Unit): Unit
- Definition Classes
- DoubleLinkedContainer
- def dlcHasOnlyOne: Boolean
- Definition Classes
- DoubleLinkedContainer
- val dlcHead: AssignmentStatement
- Definition Classes
- DoubleLinkedContainer
- def dlcIsEmpty: Boolean
- Definition Classes
- DoubleLinkedContainer
- val dlcLast: AssignmentStatement
- Definition Classes
- DoubleLinkedContainer
- def dlcPrepend(that: AssignmentStatement): SInt.this.type
- Definition Classes
- DoubleLinkedContainer
- def dontSimplifyIt(): SInt.this.type
- def drop(n: Int): Bits
Drop lowerst n bits
Drop lowerst n bits
- returns
data10bits(9 downto 4)
- Definition Classes
- BitVector
val res = data10bits.drop(4)
Example: - def dropHigh(n: Int): Bits
Drop highest n bits
Drop highest n bits
- returns
data10bits(5 downto 0)
- Definition Classes
- BitVector
val res = data10bits.dropHigh(4)
Example: - def dropLow(n: Int): Bits
- Definition Classes
- BitVector
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
- Definition Classes
- OverridedEqualsHashCode → AnyRef → Any
- def existsTag(cond: (SpinalTag) => Boolean): Boolean
- Definition Classes
- SpinalTagReady
- def expand: SInt
- def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
- Definition Classes
- SpinalTagReady
- def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
- Definition Classes
- SpinalTagReady
- def fixTo(q: QFormat): SInt
- def fixTo(q: QFormat, roundType: RoundType): SInt
- def fixTo(q: QFormat, roundType: RoundType, sym: Boolean): SInt
- def fixTo(section: Inclusive): SInt
- def fixTo(section: Inclusive, roundType: RoundType): SInt
- def fixTo(section: Inclusive, roundType: RoundType, sym: Boolean): SInt
- def flatten: Seq[BaseType]
- def flattenForeach(body: (BaseType) => Unit): Unit
- def flattenLocalName: Seq[String]
- def flip(): SInt.this.type
flip the direction of the data
flip the direction of the data
- Definition Classes
- Data
- def floor(n: Int): SInt
return w(this)-n bits
- def floor(width: BitCount): SInt
- Definition Classes
- Num
- def floorToZero(n: Int): SInt
SInt roundUp lowest m bits, friendly for hardware timing and area sign * floor(abs(x))
- def floorToZero(width: BitCount): SInt
- Definition Classes
- Num
- def foreachClockDomain(func: (ClockDomain) => Unit): Unit
- def foreachDrivingExpression(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def foreachExpression(func: (Expression) => Unit): Unit
- Definition Classes
- DeclarationStatement → ExpressionContainer
- def foreachReflectableNameables(doThat: (Any) => Unit): Unit
- Definition Classes
- Nameable
- def foreachStatements(func: (AssignmentStatement) => Unit): Unit
- Definition Classes
- StatementDoubleLinkedContainer
- def foreachTag(body: (SpinalTag) => Unit): Unit
- Definition Classes
- SpinalTagReady
- def freeze(): SInt.this.type
- def genIf(cond: Boolean): SInt.this.type
Generate this if condition is true
Generate this if condition is true
- Definition Classes
- Data
- def getAheadValue(): SInt.this.type
- def getAllTrue: SInt.this.type
- def getBitsWidth: Int
Return the width of the data
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getComponent(): Component
- Definition Classes
- Data → InComponent → NameableByComponent
- def getComponents(): Seq[Component]
Get current component with all parents
Get current component with all parents
- Definition Classes
- InComponent
- def getDirection: IODirection
- Definition Classes
- Data
- def getDisplayName(): String
- Definition Classes
- Nameable
- def getDrivingReg: SInt.this.type
- Definition Classes
- BaseType
- def getInstanceCounter: Int
- Definition Classes
- ContextUser
- def getMode: Byte
- Attributes
- protected
- Definition Classes
- Nameable
- def getName(default: String): String
- Definition Classes
- NameableByComponent → Nameable
- def getName(): String
- Definition Classes
- NameableByComponent → Nameable
- def getPartialName(): String
- Definition Classes
- Nameable
- def getRealSource: Any
- Definition Classes
- Assignable
- def getRealSourceNoRec: Any
- Definition Classes
- Data → Assignable
- def getRefOwnersChain(): List[Any]
- Definition Classes
- OwnableRef
- def getRootParent: Data
- Definition Classes
- Data
- def getRtlPath(separator: String = "/"): String
- Definition Classes
- Data
- def getScalaLocationLong: String
- Definition Classes
- ScalaLocated
- def getScalaLocationShort: String
- Definition Classes
- ScalaLocated
- def getScalaTrace(): Throwable
- Definition Classes
- ScalaLocated
- def getSingleDriver: Option[SInt.this.type]
- Definition Classes
- BaseType
- def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
- Definition Classes
- SpinalTagReady
- def getTags(): LinkedHashSet[SpinalTag]
- Definition Classes
- SpinalTagReady
- def getTypeObject: TypeSInt
- Definition Classes
- SInt → Expression
- def getWidth: Int
- Definition Classes
- Widthable → WidthProvider
- def getWidthNoInferation: Int
Return the width
Return the width
- Definition Classes
- BitVector
- def getWidthStringNoInferation: String
- Definition Classes
- BitVector
- def getZero: SInt.this.type
Create a data set to 0
- def getZeroUnconstrained: SInt.this.type
- val globalData: GlobalData
- Definition Classes
- GlobalDataUser
- def hasAssignement: Boolean
- Definition Classes
- BaseType
- def hasDataAssignment: Boolean
- Definition Classes
- BaseType
- def hasInit: Boolean
Does the base type have initial value
Does the base type have initial value
- Definition Classes
- BaseType
- def hasOnlyOneStatement: Boolean
- Definition Classes
- StatementDoubleLinkedContainer
- def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
- Definition Classes
- SpinalTagReady
- def hasTag(spinalTag: SpinalTag): Boolean
- Definition Classes
- SpinalTagReady
- def hashCode(): Int
- Definition Classes
- OverridedEqualsHashCode → AnyRef → Any
- def head: AssignmentStatement
- Definition Classes
- StatementDoubleLinkedContainer
- def high: Int
Return the upper bound
Return the upper bound
- Definition Classes
- BitVector
- def init(that: SInt): SInt
Set initial value to a data
Set initial value to a data
- Definition Classes
- DataPrimitives
- final def initFrom(that: AnyRef, target: AnyRef = this): Unit
- Definition Classes
- Data
- def initial(that: SInt): SInt
- Definition Classes
- BaseTypePrimitives
- def initialFrom(that: AnyRef, target: AnyRef = this): Unit
- Definition Classes
- BaseType
- def insertNext(s: Statement): Unit
- Definition Classes
- Statement
- def instanceAttributes(language: Language): Iterable[Attribute]
- Definition Classes
- SpinalTagReady
- def instanceAttributes: Iterable[Attribute]
- Definition Classes
- SpinalTagReady
- def isAnalog: Boolean
- def isComb: Boolean
- def isCompletelyUnnamed: Boolean
- Definition Classes
- Nameable
- def isDirectionLess: Boolean
- Definition Classes
- Data
- def isEmptyOfTag: Boolean
- Definition Classes
- SpinalTagReady
- def isFrozen(): Boolean
- Definition Classes
- BaseType
- def isInOut: Boolean
- Definition Classes
- Data
- def isInput: Boolean
- Definition Classes
- Data
- def isInputOrInOut: Boolean
- Definition Classes
- Data
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNamed: Boolean
- Definition Classes
- NameableByComponent → Nameable
- def isOutput: Boolean
- Definition Classes
- Data
- def isOutputOrInOut: Boolean
- Definition Classes
- Data
- def isPriorityApplicable(namePriority: Byte): Boolean
- Definition Classes
- Nameable
- def isReg: Boolean
- def isTypeNode: Boolean
Is the baseType a node
Is the baseType a node
- Definition Classes
- BaseType
- def isUnnamed: Boolean
- Definition Classes
- Nameable
- def isUsingResetSignal: Boolean
Is the basetype using reset signal
Is the basetype using reset signal
- Definition Classes
- BaseType
- def isUsingSoftResetSignal: Boolean
Is the basetype using soft reset signal
Is the basetype using soft reset signal
- Definition Classes
- BaseType
- def isVital: Boolean
Check if the baseType is vital
Check if the baseType is vital
- Definition Classes
- BaseType
- val lastScopeStatement: Statement
- Definition Classes
- Statement
- def lsb: Bool
Return the least significant bit
Return the least significant bit
- Definition Classes
- BitVector
- def max(right: SInt): SInt
Return the maximum value between this and right
Return the maximum value between this and right
- Definition Classes
- Num
- def maxValue: BigInt
- Definition Classes
- SInt → MinMaxProvider
- def min(right: SInt): SInt
Return the minimum value between this and right
Return the minimum value between this and right
- Definition Classes
- Num
- def minValue: BigInt
- Definition Classes
- SInt → MinMaxProvider
- def msb: Bool
Return the most significant bit
Return the most significant bit
- Definition Classes
- BitVector
- def mux[T2 <: Data](mappings: (Any, T2)*): T2
- Definition Classes
- BaseType
- def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
- Definition Classes
- BaseType
- def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
- Definition Classes
- BaseType
- def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
- Definition Classes
- BaseType
- val name: String
- Definition Classes
- Nameable
- val nameableRef: Nameable
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newExtract(offset: UInt, size: Int, extract: BitVectorRangedAccessFloating): SInt.this.type
Extract a range of bits of the BitVector
Extract a range of bits of the BitVector
- Definition Classes
- BitVector
- def newExtract(hi: Int, lo: Int, accessFactory: => BitVectorRangedAccessFixed): SInt.this.type
Extract a range of bits of the BitVector
Extract a range of bits of the BitVector
- Definition Classes
- BitVector
- def newExtract(bitId: UInt, extract: BitVectorBitAccessFloating): Bool
Extract a bit of the BitVector
Extract a bit of the BitVector
- Definition Classes
- BitVector
- def newExtract(bitId: Int, extract: BitVectorBitAccessFixed): Bool
Extract a bit of the BitVector
Extract a bit of the BitVector
- Definition Classes
- BitVector
- val nextScopeStatement: Statement
- Definition Classes
- Statement
- def noBackendCombMerge: SInt.this.type
- Definition Classes
- Data
- def noCombLoopCheck: SInt.this.type
- Definition Classes
- Data
- def normalizeInputs: Unit
- Definition Classes
- BaseType → ExpressionContainer
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onEachAttributes(doIt: (Attribute) => Unit): Unit
- Definition Classes
- SpinalTagReady
- def opName: String
- Definition Classes
- SInt → Expression
- def orMask(that: Bool): SInt.this.type
- Definition Classes
- BitVector
- def orR: Bool
Logical OR of all bits
Logical OR of all bits
- Definition Classes
- BitVector
- def overrideLocalName(name: String): SInt.this.type
- Definition Classes
- Nameable
- val parent: Data
- Definition Classes
- Data
- val parentScope: ScopeStatement
- Definition Classes
- ContextUser
- def pull(propagateName: Boolean): SInt.this.type
- Definition Classes
- Data
- def pull(): SInt.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
- def purify(): SInt.this.type
- Definition Classes
- Data
- def randBoot(u: Unit): SInt.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
- val refOwner: RefOwnerType
- Definition Classes
- OwnableRef
- Annotations
- @DontName()
- def reflectNames(): Unit
- Definition Classes
- Nameable
- def remapDrivingExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- ExpressionContainer
- def remapExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- DeclarationStatement → ExpressionContainer
- def removeAssignments(): SInt.this.type
Remove all assignments of the base type
- def removeStatement(): Unit
- def removeStatementFromScope(): Unit
- Definition Classes
- Statement
- def removeTag(spinalTag: SpinalTag): SInt.this.type
- Definition Classes
- SpinalTagReady
- def removeTags(tags: Iterable[SpinalTag]): SInt.this.type
- Definition Classes
- SpinalTagReady
- def resize(width: BitCount): SInt
- def resize(width: Int): SInt.this.type
Resize the bitVector to width
- def resized: SInt.this.type
Resized data regarding target
Resized data regarding target
- Definition Classes
- Data
- def reversed: SInt
- def rootScopeStatement: ScopeStatement
- def rotateLeft(that: Int): SInt
Left rotation of that bits
- def rotateLeft(that: UInt): T
Left rotation of that Bits
Left rotation of that Bits
- Definition Classes
- BitVector
- def rotateRight(that: Int): SInt
Right rotation of that bits
- def rotateRight(that: UInt): T
Right rotation of that Bits
Right rotation of that Bits
- Definition Classes
- BitVector
- def round(n: Int, align: Boolean = true): SInt
- def round(width: BitCount, align: Boolean): SInt
- Definition Classes
- Num
- def roundDown(n: Int, align: Boolean): SInt
SInt roundDown lowest m bits, complex for hardware , not recommended The algorithm represented by python code : ceil(x - 0.5)
- def roundDown(width: BitCount, align: Boolean): SInt
- Definition Classes
- Num
- def roundToInf(n: Int, align: Boolean = true): SInt
SInt roundToInf sign * floor(abs(x) + 0.5)
- def roundToInf(width: BitCount, align: Boolean): SInt
- Definition Classes
- Num
- def roundToZero(n: Int, align: Boolean): SInt
SInt roundToZero The algorithm represented by python code : sign * ceil(abs(x) - 0.5)
- def roundToZero(width: BitCount, align: Boolean): SInt
- Definition Classes
- Num
- def roundUp(n: Int, align: Boolean = true): SInt
SInt roundUp lowest m bits, friendly for hardware timing and area floor(x + 0.5)
- def roundUp(width: BitCount, align: Boolean): SInt
- Definition Classes
- Num
- def sat(m: Int): SInt
Saturation highest m bits
- def sat(width: BitCount): SInt
- Definition Classes
- Num
- def satWithSym(m: Int): SInt
- val scalaTrace: Throwable
- Definition Classes
- ScalaLocated
- def setAll(): SInt.this.type
Set all bits
- def setAllTo(value: Bool): SInt.this.type
Set all bits to value
Set all bits to value
- Definition Classes
- BitVector
- def setAllTo(value: Boolean): SInt.this.type
Set all bits to value
Set all bits to value
- Definition Classes
- BitVector
- def setAsAnalog(): SInt.this.type
- def setAsComb(): SInt.this.type
Set baseType to Combinatorial
- def setAsDirectionLess(): SInt.this.type
remove the direction (in,out,inout) to a data
- def setAsReg(): SInt.this.type
Set baseType to reg
- def setAsTypeNode(): SInt.this.type
Set baseType to Node
Set baseType to Node
- Definition Classes
- BaseType
- def setAsVital(): SInt.this.type
Set the baseType to vital
Set the baseType to vital
- Definition Classes
- BaseType
- def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SInt.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SInt.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String): SInt.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, namePriority: Byte): SInt.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, weak: Boolean): SInt.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable): SInt.this.type
- Definition Classes
- Nameable
- def setName(name: String, namePriority: Byte): SInt.this.type
- Definition Classes
- Nameable
- def setName(name: String, weak: Boolean): SInt.this.type
- Definition Classes
- Nameable
- def setName(name: String): SInt.this.type
- Definition Classes
- Nameable
- def setNameAsWeak(): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte, owner: Any): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, weak: Boolean): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, namePriority: Byte): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, weak: Boolean): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String): SInt.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String): SInt.this.type
- Definition Classes
- Nameable
- def setRefOwner(that: Any): Unit
- Definition Classes
- OwnableRef
- def setScalaLocated(source: ScalaLocated): SInt.this.type
- Definition Classes
- ScalaLocated
- def setWeakName(name: String): SInt.this.type
- Definition Classes
- Nameable
- def setWidth(width: Int): SInt.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
- Definition Classes
- BitVector
- def sign: Bool
- def simplifyNode: Expression
- Definition Classes
- Expression
- def sliceBy(divisor: List[Int]): List[Bits]
- Definition Classes
- BitVector
- 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))
- Definition Classes
- BitVector
val res = A.sliceBy(2, 3, 5) val res = A.sliceBy(List(2, 3, 5))
Example: - def spinalTags: LinkedHashSet[SpinalTag]
- Definition Classes
- SpinalTagReady
- 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))
- Definition Classes
- BitVector
val res = data10bits.splitAt(4)
Example: - def stabilized(func: (Expression) => Expression, seed: Expression): Expression
- Definition Classes
- ExpressionContainer
- def subdivideIn(sliceWidth: BitCount): Vec[T]
- Definition Classes
- BitVector
- def subdivideIn(sliceCount: SlicesCount): Vec[T]
- Definition Classes
- BitVector
- def subdivideIn(sliceWidth: BitCount, strict: Boolean): Vec[T]
Split the BitVector into slice of x bits * @example
Split the BitVector into slice of x bits * @example
val res = myBits.subdiviedIn(3 bits)
- sliceWidth
the width of the slice
- returns
a Vector of slices
- Definition Classes
- BitVector
- 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
- returns
a Vector of slices
- Definition Classes
- BitVector
val res = myBits.subdiviedIn(3 slices)
Example: - def swichAssign[T2 <: BaseType](sel: T2)(mappings: (Any, SInt)*): Unit
- Definition Classes
- DataPrimitives
- def symmetry: SInt
SInt symmetric
SInt symmetric
- returns
return a SInt which minValue equal -maxValue
val symmetrySInt = mySInt.symmetry
Example: - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tag(q: QFormat): SInt
- def take(n: Int): Bits
Take lowerst n bits
Take lowerst n bits
- returns
data10bits(3 downto 0)
- Definition Classes
- BitVector
val res = data10bits.take(4)
Example: - def takeHigh(n: Int): Bits
Take highest n bits
Take highest n bits
- returns
data10bits(9 downto 6)
- Definition Classes
- BitVector
val res = data10bits.takeHigh(4)
Example: - def takeLow(n: Int): Bits
- Definition Classes
- BitVector
- def toIo(): SInt.this.type
- Definition Classes
- Data
- def toString(): String
- Definition Classes
- BitVector → BaseType → Expression → Nameable → AnyRef → Any
- def toStringMultiLine(): String
- Definition Classes
- BaseNode
- def toStringRec(level: Int = 1): String
- Definition Classes
- Expression
- def trim(m: Int): SInt
highest m bits Discard
- def trim(width: BitCount): SInt
- Definition Classes
- Num
- def unary_-: SInt
Negative number
Negative number
- returns
return a negative number
val result = -mySInt
Example: - def unary_~: SInt
Inverse bitwise operator
- def unfreeze(): SInt.this.type
- def unsetName(): SInt.this.type
- Definition Classes
- Nameable
- def valueRange: Range
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def walkDrivingExpressions(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def walkExpression(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def walkExpressionPostorder(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def walkParentTreeStatements(func: (TreeStatement) => Unit): Unit
- Definition Classes
- Statement
- def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) => Unit): Unit
- Definition Classes
- Statement
- def walkRemapDrivingExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- ExpressionContainer
- def walkRemapExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- ExpressionContainer
- def wrapCast[T <: BaseType](result: T, node: Cast): T
- Definition Classes
- BaseType
- def wrapNext(): SInt.this.type
- Definition Classes
- Data
- def xorR: Bool
Logical XOR of all bits
Logical XOR of all bits
- Definition Classes
- BitVector
- def |(right: SInt): SInt
Logical OR operator
- def |<<(that: UInt): SInt
Logical shift left (output width == input width)
- def |<<(that: Int): SInt
Logical shift left (output width == input width)
- def |>>(that: UInt): SInt
Logical shift Right (output width == input width)
- def |>>(that: Int): SInt
Logical shift right (output width == input width)
Logical shift right (output width == input width)
- that
the number of right shift
- returns
a Bits of width : w(this)
val result = myUInt |>> 4
Example:
Deprecated Value Members
- def asDirectionLess(): SInt.this.type
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version ???) use setAsDirectionLess instead
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def range: Range
Return the range
Return the range
- Definition Classes
- BitVector
- Annotations
- @deprecated
- Deprecated
Use bitsRange instead