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
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- 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
- def +(other: String): String
- def ->[B](y: B): (BitPat, B)
- 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()
- def cover(that: BitSet): Boolean
Check whether this
BitSetcovers that (i.e. - def do_##(that: BitPat)(implicit sourceInfo: SourceInfo): BitPat
- def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo): Bool
- def do_===(that: UInt)(implicit sourceInfo: SourceInfo): Bool
- def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo): BitPat
- def do_apply(x: Int)(implicit sourceInfo: SourceInfo): BitPat
- def ensuring(cond: (BitPat) => Boolean, msg: => Any): BitPat
- def ensuring(cond: (BitPat) => Boolean): BitPat
- def ensuring(cond: Boolean, msg: => Any): BitPat
- def ensuring(cond: Boolean): BitPat
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
Test whether two
BitSetmatches the same set of value - def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getWidth: Int
Get specified width of said BitPat
- def hashCode(): Int
- Definition Classes
- BitPat → AnyRef → Any
- def intersect(that: BitPat): BitSet
Intersect
thisandthatBitPat.Intersect
thisandthatBitPat.- that
BitPatto be intersected.- returns
a
BitSetcontaining all elements ofthisthat also belong tothat.
- def intersect(that: BitSet): BitSet
Intersect
thisandthatBitSet.Intersect
thisandthatBitSet.- that
BitSetto be intersected.- returns
a
BitSetcontaining all elements ofthisthat also belong tothat.
- Definition Classes
- BitSet
- def inverse: BitSet
Calculate the inverse of this pattern set.
Calculate the inverse of this pattern set.
- returns
A BitSet matching all value (of the given with) iff it doesn't match this pattern.
- Definition Classes
- BitSet
- def isEmpty: Boolean
whether this
BitSetis empty (i.e. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mask: BigInt
- def matches(input: UInt): Bool
- Definition Classes
- BitSet
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def overlap(that: BitSet): Boolean
Check whether this
BitPatoverlap with thatBitPat, i.e. - def rawString: String
Generate raw string of a
BitPat. - def subtract(that: BitPat): BitSet
Subtract a
BitPatfrom this.Subtract a
BitPatfrom this.- that
subtrahend
BitPat.- returns
a
BitSetcontaining elements ofthiswhich are not the elements ofthat.
- def subtract(that: BitSet): BitSet
Subtract that from this
BitSet.Subtract that from this
BitSet.- that
subtrahend
BitSet.- returns
a
BitSetcontining elements ofthiswhich are not the elements ofthat.
- Definition Classes
- BitSet
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def terms: Set[BitPat]
all
BitPatelements in terms make up thisBitSet. - def toString(): String
- def union(that: BitSet): BitSet
Union this and that
BitSetUnion this and that
BitSet- that
BitSetto union.- returns
a
BitSetcontaining all elements ofthisandthat.
- Definition Classes
- BitSet
- val value: BigInt
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- val width: Int
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BitPat toStringFormat[BitPat] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (BitPat, B)
- Implicit
- This member is added by an implicit conversion from BitPat toArrowAssoc[BitPat] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
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
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.