sealed class Interval extends Bits with Num[Interval] with HasBinaryPoint
A sealed class representing a fixed point number that has a range, an additional parameter that can determine a minimum and maximum supported value. The range can be used to reduce the required widths particularly in primitive operations with other Intervals, the canonical example being
val one = 1.I val six = Seq.fill(6)(one).reduce(_ + _)
A UInt computed in this way would require a Width binary point The width and binary point may be inferred.
IMPORTANT: The API provided here is experimental and may change in the future.
- Source
- Bits.scala
- Grouped
- Alphabetic
- By Inheritance
- Interval
- HasBinaryPoint
- Num
- Bits
- ToBoolable
- Element
- Data
- SourceInfoDoc
- NamedComponent
- HasId
- InstanceId
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final macro def !=(that: Interval): Bool
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final macro def ##(that: Bits): UInt
Concatenation operator
Concatenation operator
- that
a hardware component
- returns
this numeric-like type concatenated to the most significant end of
that
- Definition Classes
- Bits
- Note
The width of the returned hardware type is
width of this+width of that.
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final macro def %(that: Interval): Interval
Modulo operator
Modulo operator
- that
a hardware type
- returns
the remainder of this numeric-like type divided by
that
- Definition Classes
- Num
- Note
This method generates a fully combinational divider which can result in significant cycle time and area costs.
- final macro def &(that: Interval): Interval
- final macro def *(that: Interval): Interval
Multiplication operator
Multiplication operator
- that
a hardware type
- returns
the product of this numeric-like type and
that
- Definition Classes
- Num
- Note
The width of the returned hardware type is
,width of this+width of that.This method generates a fully combinational multiplier which can result in significant cycle time and area costs.
- final macro def +(that: Interval): Interval
Addition operator
Addition operator
- that
a hardware type
- returns
the sum of this numeric-like type and
that
- Definition Classes
- Num
- Note
The width of the returned hardware type is
max(width of this, width of that).
- final macro def +%(that: Interval): Interval
add (no growth) operator
- final macro def +&(that: Interval): Interval
add (width +1) operator
- final macro def -(that: Interval): Interval
Subtraction operator
Subtraction operator
- that
a hardware type
- returns
the difference of this numeric-like type less
that
- Definition Classes
- Num
- Note
The width of the returned hardware type is
max(width of this, width of that) + 1.
- final macro def -%(that: Interval): Interval
subtract (no growth) operator
- final macro def -&(that: Interval): Interval
subtract (width +1) operator
- final macro def /(that: Interval): Interval
Division operator
Division operator
- that
a hardware type
- returns
the quotient of this numeric-like type divided by
that
- Definition Classes
- Num
- To do
full rules
- Note
This method generates a fully combinational divider which can result in significant cycle time and area costs.
- final def :=(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
Connect this numeric-like type to that numeric-like type mono-directionally and element-wise.
Connect this numeric-like type to that numeric-like type mono-directionally and element-wise.
This uses the MonoConnect algorithm.
- that
the numeric-like type to connect to
- Definition Classes
- Data
- final macro def <(that: Interval): Bool
Less than operator
- final macro def <<(that: UInt): Bits
Dynamic left shift operator
Dynamic left shift operator
- that
a hardware component
- returns
this numeric-like type dynamically shifted left by
thatmany places, shifting in zeros from the right
- Definition Classes
- Bits
- Note
The width of the returned numeric-like type is
width of this + pow(2, width of that) - 1.
- final macro def <<(that: Int): Bits
Static left shift operator
Static left shift operator
- that
an amount to shift by
- returns
this numeric-like type with
thatmany zeros concatenated to its least significant end
- Definition Classes
- Bits
- Note
The width of the returned numeric-like type is
width of this+that.
- final macro def <<(that: BigInt): Bits
Static left shift operator
Static left shift operator
- that
an amount to shift by
- returns
this numeric-like type with
thatmany zeros concatenated to its least significant end
- Definition Classes
- Bits
- Note
The width of the returned numeric-like type is
width of this+that.
- final macro def <=(that: Interval): Bool
Less than or equal to operator
- final def <>(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
Connect this numeric-like type to that numeric-like type bi-directionally and element-wise.
Connect this numeric-like type to that numeric-like type bi-directionally and element-wise.
This uses the BiConnect algorithm.
- that
the numeric-like type to connect to
- Definition Classes
- Data
- final macro def =/=(that: Interval): Bool
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final macro def ===(that: Interval): Bool
- final macro def >(that: Interval): Bool
Greater than operator
- final macro def >=(that: Interval): Bool
Greater than or equal to operator
- final macro def >>(that: UInt): Bits
Dynamic right shift operator
Dynamic right shift operator
- that
a hardware component
- returns
this numeric-like type dynamically shifted right by the value of
thatcomponent, inserting zeros into the most significant bits.
- Definition Classes
- Bits
- Note
The width of the returned hardware type is unchanged, i.e., the
width of this.
- final macro def >>(that: Int): Bits
Static right shift operator
Static right shift operator
- that
an amount to shift by
- returns
this numeric-like type with
thatmany least significant bits truncated
- Definition Classes
- Bits
- Note
The width of the returned hardware type is unchanged, i.e., the
width of this.
- final macro def >>(that: BigInt): Bits
Static right shift operator
Static right shift operator
- that
an amount to shift by
- returns
this numeric-like type with
thatmany least significant bits truncated
- Definition Classes
- Bits
- Note
The width of the returned hardware type is unchanged, i.e., the
width of this.
- final macro def ^(that: Interval): Interval
- final macro def abs: Interval
Absolute value operator
Absolute value operator
- returns
a hardware type with a value equal to the absolute value of this numeric-like type
- Definition Classes
- Num
- Note
The width of the returned hardware type is unchanged, i.e., the
width of this.
- final macro def apply(x: BigInt, y: BigInt): UInt
Returns a subset of bits on this numeric-like type from
hitolo(inclusive), statically addressed.Returns a subset of bits on this numeric-like type from
hitolo(inclusive), statically addressed.- x
the high bit
- y
the low bit
- returns
a hardware component contain the requested bits
- Definition Classes
- Bits
myBits = 0x5 = 0b101 myBits(1,0) => 0b01 // extracts the two least significant bits
Example: - final macro def apply(x: Int, y: Int): UInt
Returns a subset of bits on this numeric-like type from
hitolo(inclusive), statically addressed.Returns a subset of bits on this numeric-like type from
hitolo(inclusive), statically addressed.- x
the high bit
- y
the low bit
- returns
a hardware component contain the requested bits
- Definition Classes
- Bits
myBits = 0x5 = 0b101 myBits(1,0) => 0b01 // extracts the two least significant bits
Example: - 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 numeric-like type as a Bool, statically addressed.
- final macro def apply(x: BigInt): Bool
Returns the specified bit on this numeric-like type as a Bool, statically addressed.
- final macro def asBool: Bool
Casts this numeric-like type to a Bool
Casts this numeric-like type to a Bool
- Definition Classes
- ToBoolable
- Note
The width must be known and equal to 1
- 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 numeric-like type as a FixedPoint.
Reinterpret this numeric-like type as a FixedPoint.
- Definition Classes
- Bits
- Note
The value is not guaranteed to be preserved. For example, a UInt of width 3 and value 7 (0b111) would become a FixedPoint with value -1. The interpretation of the number is also affected by the specified binary point. Caution is advised!
- 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
Reinterpret this numeric-like type as an 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): Interval.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 binaryPoint: BinaryPoint
- Definition Classes
- Interval → HasBinaryPoint
- def binding: Option[Binding]
- def binding_=(target: Binding): Unit
- Attributes
- protected
- Definition Classes
- Data
- def circuitName: String
- Attributes
- protected
- Definition Classes
- HasId
- final macro def clip(that: IntervalRange): Interval
Clip this interval into the range determined by argument's range Adds hardware to move values outside of clipped range to the boundary Ignores binary point of argument
Clip this interval into the range determined by argument's range Adds hardware to move values outside of clipped range to the boundary Ignores binary point of argument
- that
an SInt whose width determines the clipping
- final macro def clip(that: SInt): Interval
Clip this interval into the range determined by argument's range Adds hardware to move values outside of clipped range to the boundary
Clip this interval into the range determined by argument's range Adds hardware to move values outside of clipped range to the boundary
- that
an SInt whose width determines the clipping
- final macro def clip(that: UInt): Interval
Clip this interval into the range determined by argument's range Adds hardware to change values outside of clipped range to be at the boundary
Clip this interval into the range determined by argument's range Adds hardware to change values outside of clipped range to be at the boundary
- that
an UInt whose width determines the clipping
- final macro def clip(that: Interval): Interval
Clip this interval into the range determined by argument's range Adds hardware to change values outside of clipped range to be at the boundary Ignores binary point of argument
Clip this interval into the range determined by argument's range Adds hardware to change values outside of clipped range to be at the boundary Ignores binary point of argument
- that
an Interval whose properties determine the clipping
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def cloneType: Interval.this.type
Internal API; Chisel users should look at chisel3.chiselTypeOf(...).
- def connect(that: Data)(implicit sourceInfo: SourceInfo, connectCompileOptions: CompileOptions): Unit
- final macro def decreasePrecision(that: Int): Interval
Decrease the precision of this Interval, moves the binary point to the right.
Decrease the precision of this Interval, moves the binary point to the right. aaa.bbb -> aaa.b
- that
number of bits to move binary point
- def do_!=(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_##(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- def do_%(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_&(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_*(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_+(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
add (default - growing) operator
- def do_+%(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_+&(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_-(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
subtract (default - growing) operator
- def do_-%(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_-&(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_/(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_<(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_<<(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_<<(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_<<(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_<=(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_=/=(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_===(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_>(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_>=(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_>>(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_>>(that: BigInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_>>(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_^(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- 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(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_asInterval(that: IntervalRange)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- Definition Classes
- Bits
- 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
- def do_clip(that: IntervalRange)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_clip(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_clip(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_clip(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_decreasePrecision(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- 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_fromBits(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval.this.type
- def do_head(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- def do_increasePrecision(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_max(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- Definition Classes
- Num
- def do_min(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- Definition Classes
- Num
- def do_pad(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval.this.type
- Definition Classes
- Bits
- def do_setPrecision(that: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_squeeze(that: IntervalRange)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_squeeze(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_squeeze(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_squeeze(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_tail(n: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Bits
- def do_unary_-(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_unary_-%(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_unary_~(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
Returns this wire bitwise-inverted.
- def do_wrap(that: IntervalRange)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_wrap(that: SInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_wrap(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_wrap(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- def do_|(that: Interval)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Interval
- 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 numeric-like type 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
Head operator
- n
the number of bits to take
- returns
The
nmost significant bits of this numeric-like type
- Definition Classes
- Bits
- final macro def increasePrecision(that: Int): Interval
Increase the precision of this Interval, moves the binary point to the left.
Increase the precision of this Interval, moves the binary point to the left. aaa.bbb -> aaa.bbb00
- that
how many bits to shift binary point
- 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 litToBigDecimal: BigDecimal
Return the BigDecimal value of this instance assuming it is a literal (convenience method)
Return the BigDecimal value of this instance assuming it is a literal (convenience method)
- Definition Classes
- HasBinaryPoint
- def litToBigDecimalOption: Option[BigDecimal]
Return the BigDecimal value of this instance if it is a Literal
Return the BigDecimal value of this instance if it is a Literal
- Definition Classes
- HasBinaryPoint
- Note
this method may throw an exception if the literal value won't fit in a BigDecimal
- def litToDouble: Double
Return the double value of this instance assuming it is a literal (convenience method)
Return the double value of this instance assuming it is a literal (convenience method)
- Definition Classes
- HasBinaryPoint
- def litToDoubleOption: Option[Double]
Return the Double value of this instance if it is a Literal
Return the Double value of this instance if it is a Literal
- Definition Classes
- HasBinaryPoint
- Note
this method may throw an exception if the literal value won't fit in a Double
- 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: Interval): Interval
Maximum operator
Maximum operator
- that
a hardware type
- returns
a hardware type with a value equal to the minimum value of this numeric-like type and
that
- Definition Classes
- Num
- Note
The width of the returned hardware type is
max(width of this, width of that).
- final macro def min(that: Interval): Interval
Minimum operator
Minimum operator
- that
a hardware numeric-like type
- returns
a hardware type with a value equal to the minimum value of this numeric-like type and
that
- Definition Classes
- Num
- Note
The width of the returned hardware type is
max(width of this, width of that).
- 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): Interval.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
- val range: IntervalRange
- final macro def setPrecision(that: Int): Interval
- final macro def squeeze(that: IntervalRange): Interval
Squeeze returns the intersection of the ranges this interval and that IntervalRange Ignores binary point of argument Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
Squeeze returns the intersection of the ranges this interval and that IntervalRange Ignores binary point of argument Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
- that
an Interval whose properties determine the squeezing
- final macro def squeeze(that: SInt): Interval
Squeeze returns the intersection of the ranges this interval and that SInt Currently, that must have a defined width Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
Squeeze returns the intersection of the ranges this interval and that SInt Currently, that must have a defined width Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
- that
an SInt whose properties determine the squeezing
- final macro def squeeze(that: UInt): Interval
Squeeze returns the intersection of the ranges this interval and that UInt Currently, that must have a defined width Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
Squeeze returns the intersection of the ranges this interval and that UInt Currently, that must have a defined width Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
- that
an UInt whose properties determine the squeezing
- final macro def squeeze(that: Interval): Interval
Squeeze returns the intersection of the ranges this interval and that Interval Ignores binary point of argument Treat as an unsafe cast; gives undefined behavior if this signal's value is outside of the resulting range Adds no additional hardware; this strictly an unsafe type conversion to use at your own risk
- def suggestName(seed: => String): Interval.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
Tail operator
- n
the number of bits to remove
- returns
This numeric-like type with the
nmost significant bits removed.
- Definition Classes
- Bits
- 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
- Interval → 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
- def toType: String
- final macro def unary_-: Interval
- final macro def unary_-%: Interval
- final macro def unary_~: Bits
Bitwise inversion operator
Bitwise inversion operator
- returns
this numeric-like type with each bit inverted
- Definition Classes
- Bits
- 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 wrap(that: IntervalRange): Interval
Wrap this interval into the range determined by an IntervalRange Adds hardware to change values outside of wrapped range to be at the boundary Errors if requires wrapping more than once Ignores binary point of argument
Wrap this interval into the range determined by an IntervalRange Adds hardware to change values outside of wrapped range to be at the boundary Errors if requires wrapping more than once Ignores binary point of argument
- that
an Interval whose properties determine the bounds of the wrap
- final macro def wrap(that: SInt): Interval
Wrap this interval into the range determined by an SInt Errors if requires wrapping more than once
Wrap this interval into the range determined by an SInt Errors if requires wrapping more than once
- that
an SInt whose properties determine the bounds of the wrap
- final macro def wrap(that: UInt): Interval
Wrap this interval into the range determined by that UInt Errors if requires wrapping more than once
Wrap this interval into the range determined by that UInt Errors if requires wrapping more than once
- that
an UInt whose properties determine the wrap
- final macro def wrap(that: Interval): Interval
Wrap the value of this Interval into the range of a different Interval with a presumably smaller range.
Wrap the value of this Interval into the range of a different Interval with a presumably smaller range. Ignores binary point of argument Errors if requires wrapping more than once
- final macro def |(that: Interval): Interval
Deprecated Value Members
- final macro def abs(dummy: Int*): Interval
- 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*): Interval
- 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*): Interval
- 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 HasBinaryPoint
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.