sealed class SInt extends Bits with Num[SInt]
A data type for signed integers, represented as a binary bitvector. Defines arithmetic operations between other integer types.
- Source
- Bits.scala
- Grouped
- Alphabetic
- By Inheritance
- SInt
- Num
- Bits
- ToBoolable
- Element
- Data
- SourceInfoDoc
- NamedComponent
- HasId
- InstanceId
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final macro def ##(that: Bits): UInt
Concatenation operator
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final macro def %(that: SInt): SInt
Modulo operator
- final macro def &(that: SInt): SInt
Bitwise and operator
- final macro def *(that: UInt): SInt
Multiplication operator
- final macro def *(that: SInt): SInt
Multiplication operator
- final macro def +(that: SInt): SInt
Addition operator
- final macro def +%(that: SInt): SInt
Addition operator (constant width)
- final macro def +&(that: SInt): SInt
Addition operator (expanding width)
- final macro def -(that: SInt): SInt
Subtraction operator
- final macro def -%(that: SInt): SInt
Subtraction operator (constant width)
- final macro def -&(that: SInt): SInt
Subtraction operator (increasing width)
- final macro def /(that: SInt): SInt
Division operator
- final def :=(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
Connect this SInt to that SInt mono-directionally and element-wise.
- final macro def <(that: SInt): Bool
Less than operator
- final macro def <<(that: UInt): Bits
Dynamic left shift operator
- final macro def <<(that: Int): Bits
Static left shift operator
- final macro def <<(that: BigInt): Bits
Static left shift operator
- final macro def <=(that: SInt): Bool
Less than or equal to operator
- final def <>(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
Connect this SInt to that SInt bi-directionally and element-wise.
- final macro def =/=(that: SInt): Bool
Dynamic not equals operator
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final macro def ===(that: SInt): Bool
Dynamic equals operator
- final macro def >(that: SInt): Bool
Greater than operator
- final macro def >=(that: SInt): Bool
Greater than or equal to operator
- final macro def >>(that: UInt): Bits
Dynamic right shift operator
- final macro def >>(that: Int): Bits
Static right shift operator
- final macro def >>(that: BigInt): Bits
Static right shift operator
- final macro def ^(that: SInt): SInt
Bitwise exclusive or (xor) operator
- final macro def abs: SInt
Absolute value operator
- final macro def apply(x: BigInt, y: BigInt): UInt
Returns a subset of bits on this SInt from
hitolo(inclusive), statically addressed. - final macro def apply(x: Int, y: Int): UInt
Returns a subset of bits on this SInt from
hitolo(inclusive), statically addressed. - final macro def apply(x: UInt): Bool
Returns the specified bit on this wire as a Bool, dynamically addressed.
- final macro def apply(x: Int): Bool
Returns the specified bit on this SInt as a Bool, statically addressed.
- final macro def apply(x: BigInt): Bool
Returns the specified bit on this SInt as a Bool, statically addressed.
- final macro def asBool: Bool
- final macro def asBools: Seq[Bool]
Returns the contents of this wire as a scala.collection.Seq of Bool.
Returns the contents of this wire as a scala.collection.Seq of Bool.
- Definition Classes
- Bits
- final macro def asFixedPoint(that: BinaryPoint): FixedPoint
Reinterpret this SInt as a FixedPoint.
Reinterpret this SInt as a FixedPoint.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final macro def asInterval(that: IntervalRange): Interval
Reinterpret cast as a Interval.
Reinterpret cast as a Interval.
- Definition Classes
- Bits
- Note
value not guaranteed to be preserved: for example, an UInt of width 3 and value 7 (0b111) would become a FixedInt with value -1, the interpretation of the number is also affected by the specified binary point. Caution advised
- final macro def asSInt: SInt
- macro def asTypeOf[T <: Data](that: T): T
Does a reinterpret cast of the bits in this node into the format that provides.
Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.
x.asTypeOf(that) performs the inverse operation of x := that.toBits.
- Definition Classes
- Data
- Note
bit widths are NOT checked, may pad or drop bits from input
,that should have known widths
- final macro def asUInt: UInt
Reinterpret cast to UInt.
Reinterpret cast to UInt.
- Definition Classes
- Data
- Note
value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7
,Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.
- def autoSeed(name: String): SInt.this.type
Takes the last seed suggested.
Takes the last seed suggested. Multiple calls to this function will take the last given seed, unless this HasId is a module port (see overridden method in Data.scala).
If the final computed name conflicts with the final name of another signal, the final name may get uniquified by appending a digit at the end of the name.
Is a lower priority than suggestName, in that regardless of whether autoSeed was called, suggestName will always take precedence if it was called.
- returns
this object
- Definition Classes
- Data → HasId
- def binding: Option[Binding]
- def binding_=(target: Binding): Unit
- Attributes
- protected
- Definition Classes
- Data
- def circuitName: String
- Attributes
- protected
- Definition Classes
- HasId
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def cloneType: SInt.this.type
Internal API; Chisel users should look at chisel3.chiselTypeOf(...).
- def do_##(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- def do_%(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_&(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_*(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_*(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_+(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
add (default - no growth) operator
- def do_+%(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_+&(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_-(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
subtract (default - no growth) operator
- def do_-%(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_-&(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_/(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_<(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_<<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_<<(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_<=(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_=/=(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_===(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_>(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_>=(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_>>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_>>(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_^(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- final def do_apply(x: BigInt, y: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- final def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- final def do_apply(x: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- Definition Classes
- Bits
- final def do_apply(x: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- Definition Classes
- Bits
- final def do_apply(x: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- Definition Classes
- Bits
- final def do_asBool(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- Definition Classes
- Bits → ToBoolable
- def do_asBools(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Seq[Bool]
- Definition Classes
- Bits
- def do_asFixedPoint(binaryPoint: BinaryPoint)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): FixedPoint
- def do_asInterval(range: IntervalRange = IntervalRange.Unknown)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_asSInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- Definition Classes
- Data
- def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- final def do_extract(x: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- Definition Classes
- Bits
- final def do_extract(x: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- Definition Classes
- Bits
- def do_head(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- def do_max(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- Definition Classes
- Num
- def do_min(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- Definition Classes
- Num
- def do_pad(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt.this.type
- Definition Classes
- Bits
- def do_tail(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- def do_unary_-(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_unary_-%(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_unary_~(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- def do_|(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): SInt
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- HasId → AnyRef → Any
- final macro def extract(x: UInt): Bool
Returns the specified bit on this wire as a Bool, dynamically addressed.
- final macro def extract(x: BigInt): Bool
Returns the specified bit on this SInt as a Bool, statically addressed.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def getWidth: Int
Returns the width, in bits, if currently known.
Returns the width, in bits, if currently known.
- Definition Classes
- Data
- def hasSeed: Boolean
- returns
Whether either autoName or suggestName has been called
- Definition Classes
- HasId
- def hashCode(): Int
- Definition Classes
- HasId → AnyRef → Any
- final macro def head(n: Int): UInt
Head operator
- def instanceName: String
- Definition Classes
- HasId → InstanceId
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLit: Boolean
- Definition Classes
- Data
- final def isWidthKnown: Boolean
Returns whether the width is currently known.
Returns whether the width is currently known.
- Definition Classes
- Data
- def litOption: Option[BigInt]
If this is a literal that is representable as bits, returns the value as a BigInt.
- def litValue: BigInt
Returns the literal value if this is a literal that is representable as bits, otherwise crashes.
Returns the literal value if this is a literal that is representable as bits, otherwise crashes.
- Definition Classes
- Data
- final macro def max(that: SInt): SInt
Maximum operator
- final macro def min(that: SInt): SInt
Minimum operator
- def name: String
- Definition Classes
- Element
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final macro def pad(that: Int): SInt.this.type
Pad operator
- def parentModName: String
- Definition Classes
- HasId → InstanceId
- def parentPathName: String
- Definition Classes
- HasId → InstanceId
- def pathName: String
- Definition Classes
- HasId → InstanceId
- def suggestName(seed: => String): SInt.this.type
Takes the first seed suggested.
Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.
Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.
- seed
The seed for the name of this component
- returns
this object
- Definition Classes
- HasId
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final macro def tail(n: Int): UInt
Tail operator
- final def toAbsoluteTarget: ReferenceTarget
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph
Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph
- Definition Classes
- NamedComponent → InstanceId
- final def toNamed: ComponentName
Returns a FIRRTL ComponentName that references this object
Returns a FIRRTL ComponentName that references this object
- Definition Classes
- NamedComponent → InstanceId
- Note
Should not be called until circuit elaboration is complete
- final def toPrintable: Printable
Default print as Decimal
- def toString(): String
- Definition Classes
- SInt → AnyRef → Any
- final def toTarget: ReferenceTarget
Returns a FIRRTL ReferenceTarget that references this object
Returns a FIRRTL ReferenceTarget that references this object
- Definition Classes
- NamedComponent → InstanceId
- Note
Should not be called until circuit elaboration is complete
- final macro def unary_-: SInt
Unary negation (constant width)
- final macro def unary_-%: SInt
Unary negation (constant width)
- final macro def unary_~: Bits
Bitwise inversion operator
- final def validateShiftAmount(x: Int): Int
- Attributes
- protected
- Definition Classes
- Bits
- 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 widthKnown: Boolean
- Definition Classes
- Element
- final def widthOption: Option[Int]
Returns Some(width) if the width is known, else None.
Returns Some(width) if the width is known, else None.
- Definition Classes
- Data
- final macro def |(that: SInt): SInt
Bitwise or operator
Deprecated Value Members
- final macro def abs(dummy: Int*): SInt
- Definition Classes
- Num
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def asBool(dummy: Int*): Bool
- Definition Classes
- ToBoolable
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def asBools(dummy: Int*): Seq[Bool]
- Definition Classes
- Bits
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def asSInt(dummy: Int*): SInt
- Definition Classes
- Bits
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def asUInt(dummy: Int*): UInt
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- def bindingToString: String
- Attributes
- protected
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5.0) This was never intended to be visible to user-defined types
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def isLit(dummy: Int*): Boolean
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- def litOption(dummy: Int*): Option[BigInt]
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- def litValue(dummy: Int*): BigInt
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def unary_-(dummy: Int*): SInt
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def unary_-%(dummy: Int*): SInt
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
- final macro def unary_~(dummy: Int*): Bits
- Definition Classes
- Bits
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead
Inherited from Bits
Inherited from ToBoolable
Inherited from Element
Inherited from Data
Inherited from SourceInfoDoc
Inherited from NamedComponent
Inherited from HasId
Inherited from internal.InstanceId
Inherited from AnyRef
Inherited from Any
Arithmetic
Arithmetic hardware operators
Bitwise
Bitwise hardware operators
Comparison
Comparison hardware operators
Connect
Utilities for connecting hardware components
Ungrouped
SourceInfoTransformMacro
These internal methods are not part of the public-facing API!
The equivalent public-facing methods do not have the do_ prefix or have the same name. Use and look at the
documentation for those. If you want left shift, use <<, not do_<<. If you want conversion to a
Seq of Bools look at the asBools above, not the one below. Users can safely ignore
every method in this group!
🐉🐉🐉 Here be dragons... 🐉🐉🐉
These do_X methods are used to enable both implicit passing of SourceInfo and chisel3.CompileOptions
while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your
designs, are converted to their "hidden", do_*, via macro transformations. Without using macros here, only one
of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a
chained apply as an explicit 'implicit' argument and will throw type errors.
The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method
into a call to an internal, hidden do_* that takes an explicit SourceInfo by inserting an
implicitly[SourceInfo] as the explicit argument.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt,SInt,Bool,FixedPoint,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.