chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package util

  The util package provides extensions to core chisel for common hardware components and utility functions

  The util package provides extensions to core chisel for common hardware components and utility functions

  Definition Classes
    chisel3
-  package experimental
  Definition Classes
    util
-  package decode
  Definition Classes
    experimental
- BitSet
- BoringUtils
- BoringUtilsException
- FlattenInstance
- ForceNameAnnotation
- InlineInstance
- forceName
- getAnnotations
- loadMemoryFromFile
- loadMemoryFromFileInline

t

chisel3.util.experimental

# BitSet

###
Companion object BitSet

#### sealed trait BitSet extends AnyRef

A Set of `BitPat` represents a set of bit vector with mask.

Self Type
  BitSet
Source
  BitPat.scala

Linear Supertypes
AnyRef, Any
Known Subclasses
BitPat
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BitSet
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Abstract Value Members

1.  abstract 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.

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from BitSet toany2stringadd[BitSet] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (BitSet, B)
   Implicit
     This member is added by an implicit conversion from BitSet toArrowAssoc[BitSet] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  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 b covered

   returns

     true if this `BitSet` can cover that `BitSet`

9.  def ensuring(cond: (BitSet) => Boolean, msg: => Any): BitSet
   Implicit
     This member is added by an implicit conversion from BitSet toEnsuring[BitSet] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (BitSet) => Boolean): BitSet
    Implicit
      This member is added by an implicit conversion from BitSet toEnsuring[BitSet] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): BitSet
    Implicit
      This member is added by an implicit conversion from BitSet toEnsuring[BitSet] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): BitSet
    Implicit
      This member is added by an implicit conversion from BitSet toEnsuring[BitSet] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  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

15.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
16.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def getWidth: Int

    Get specified width of said BitSet

18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  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`.

20.  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.

21.  def isEmpty: Boolean

    whether this `BitSet` is empty (i.e.

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

22.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
23.  def matches(input: UInt): Bool
24.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
25.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
27.  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.

28.  def subtract(that: BitSet): BitSet

    Subtract that from this `BitSet`.

    Subtract that from this `BitSet`.

    that

      subtrahend `BitSet`.

    returns

      a `BitSet` contining elements of `this` which are not the elements of `that`.

29.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
30.  def toString(): String
    Definition Classes
      BitSet → AnyRef → Any
31.  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`.

32.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
33.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
34.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from BitSet toStringFormat[BitSet] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (BitSet, B)
   Implicit
     This member is added by an implicit conversion from BitSet toArrowAssoc[BitSet] 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.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromBitSet to any2stringadd[BitSet]

### Inherited by implicit conversion StringFormat fromBitSet to StringFormat[BitSet]

### Inherited by implicit conversion Ensuring fromBitSet to Ensuring[BitSet]

### Inherited by implicit conversion ArrowAssoc fromBitSet to ArrowAssoc[BitSet]

### Ungrouped