sealed class BitPat extends BitSet with SourceInfoDoc
Bit patterns are literals with masks, used to represent values with don't care bits. Equality comparisons will ignore don't care bits.
- Source
- BitPat.scala
"b10101".U === BitPat("b101??") // evaluates to true.B "b10111".U === BitPat("b101??") // evaluates to true.B "b10001".U === BitPat("b101??") // evaluates to false.B
- Grouped
- Alphabetic
- By Inheritance
- BitPat
- SourceInfoDoc
- BitSet
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- macro def ##(that: BitPat): BitPat
- final def ##: Int
- Definition Classes
- AnyRef → Any
- macro def =/=(that: UInt): Bool
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- macro def ===(that: UInt): Bool
- macro def apply(x: Int, y: Int): BitPat
- macro def apply(x: Int): BitPat
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def cover(that: BitPat): Boolean
Check whether this BitSet covers that (i.e.
Check whether this BitSet covers that (i.e. forall b matches that, b also matches this)
- that
BitPat to be covered
- returns
true if this BitSet can cover that BitSet
- def cover(that: BitSet): Boolean
Check whether this BitSet covers that (i.e.
Check whether this BitSet covers that (i.e. forall b matches that, b also matches this)
- that
BitSet to be covered
- returns
true if this BitSet can cover that BitSet
- Definition Classes
- BitSet
- def do_##(that: BitPat)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): BitPat
- def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_===(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): BitPat
- def do_apply(x: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): BitPat
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
Test whether two BitSet matches the same set of value
Test whether two BitSet matches the same set of value
- returns
true if two BitSet is same.
- Definition Classes
- BitSet → AnyRef → Any
- Note
This method can be very expensive compared to ordinary == operator between two Objects
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getWidth: Int
Get specified width of said BitPat
- def hashCode(): Int
- Definition Classes
- BitPat → AnyRef → Any
- def intersect(that: BitPat): BitSet
Intersect
thisandthatBitPat. - def intersect(that: BitSet): BitSet
Intersect
thisandthatBitSet.Intersect
thisandthatBitSet.- that
BitSet to be intersected.
- returns
a BitSet containing all elements of
thisthat also belong tothat.
- Definition Classes
- BitSet
- def isEmpty: Boolean
whether this BitSet is empty (i.e.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mask: BigInt
- 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()
- def overlap(that: BitPat): Boolean
- def overlap(that: BitSet): Boolean
Check whether this BitSet overlap with that BitSet, i.e.
Check whether this BitSet overlap with that BitSet, i.e. !(intersect.isEmpty)
- that
BitSet to be checked.
- returns
true if this and that BitSet have overlap.
- Definition Classes
- BitSet
- def rawString: String
Generate raw string of a BitPat.
- def subtract(that: BitPat): BitSet
Subtract a BitPat from this.
- def subtract(that: BitSet): BitSet
Subtract that from this BitSet.
Subtract that from this BitSet.
- that
subtrahend BitSet.
- returns
a BitSet containing elements of
thiswhich are not the elements ofthat.
- Definition Classes
- BitSet
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def terms: Set[BitPat]
- def toString(): String
- def union(that: BitSet): BitSet
Union this and that BitSet
Union this and that BitSet
- that
BitSet to union.
- returns
a BitSet containing all elements of
thisandthat.
- Definition Classes
- BitSet
- val value: BigInt
- 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])
- val width: Int
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.