Packages

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
Example: 

  1. "b10101".U === BitPat("b101??") // evaluates to true.B
"b10111".U === BitPat("b101??") // evaluates to true.B
"b10001".U === BitPat("b101??") // evaluates to false.B
Linear Supertypes
SourceInfoDoc, BitSet, AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BitPat
  2. SourceInfoDoc
  3. BitSet
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BitPat(value: BigInt, mask: BigInt, width: Int)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. macro def ##(that: BitPat): BitPat
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. macro def =/=(that: UInt): Bool
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. macro def ===(that: UInt): Bool
  7. macro def apply(x: Int, y: Int): BitPat
  8. macro def apply(x: Int): BitPat
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. 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

  12. 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
  13. def do_##(that: BitPat)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): BitPat

  14. def do_=/=(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

  15. def do_===(that: UInt)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool

  16. def do_apply(x: Int, y: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): BitPat

  17. def do_apply(x: Int)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): BitPat

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. 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

  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def getWidth: Int

    Get specified width of said BitPat

    Get specified width of said BitPat

    Definition Classes
    BitPat → BitSet
  22. def hashCode(): Int
    Definition Classes
    BitPat → AnyRef → Any
  23. def intersect(that: BitPat): BitSet

    Intersect this and that BitPat.

    Intersect this and that BitPat.

    that

    BitPat to be intersected.

    returns

    a BitSet containing all elements of this that also belong to that.

  24. def intersect(that: BitSet): BitSet

    Intersect this and that BitSet.

    Intersect this and that BitSet.

    that

    BitSet to be intersected.

    returns

    a BitSet containing all elements of this that also belong to that.

    Definition Classes
    BitSet
  25. 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
  26. def isEmpty: Boolean

    whether this BitSet is empty (i.e.

    whether this BitSet is empty (i.e. no value matches)

    Definition Classes
    BitPat → BitSet
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. val mask: BigInt
  29. def matches(input: UInt): Bool
    Definition Classes
    BitSet
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def overlap(that: BitPat): Boolean

    Check whether this BitPat overlap with that BitPat, i.e.

    Check whether this BitPat overlap with that BitPat, i.e. !(intersect.isEmpty)

    that

    BitPat to be checked.

    returns

    true if this and that BitPat have overlap.

  34. 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
  35. def rawString: String

    Generate raw string of a BitPat.

  36. def subtract(that: BitPat): BitSet

    Subtract a BitPat from this.

    Subtract a BitPat from this.

    that

    subtrahend BitPat.

    returns

    a BitSet containing elements of this which are not the elements of that.

  37. def subtract(that: BitSet): BitSet

    Subtract that from this BitSet.

    Subtract that from this BitSet.

    that

    subtrahend BitSet.

    returns

    a BitSet containing elements of this which are not the elements of that.

    Definition Classes
    BitSet
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def terms: Set[BitPat]

    all BitPat elements in terms make up this BitSet.

    all BitPat elements in terms make up this BitSet. all terms should be have the same width.

    Definition Classes
    BitPat → BitSet
  40. def toString(): String
    Definition Classes
    BitPat → BitSet → AnyRef → Any
  41. 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 this and that.

    Definition Classes
    BitSet
  42. val value: BigInt
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. val width: Int

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from SourceInfoDoc

Inherited from BitSet

Inherited from AnyRef

Inherited from Any

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.