chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/chisel3/chisel3.util/chisel3.util.experimental/BitSet

BitSet

chisel3.util.experimental.BitSet
See theBitSet companion object
sealed trait BitSet

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

Attributes

Companion
object
Source
BitPat.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class BitPat
Self type

Members list

Value members

Abstract methods

def terms: Set[BitPat]

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

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

Attributes

Source
BitPat.scala

Concrete methods

def cover(that: BitSet): Boolean

Check whether this BitSet covers that (i.e. forall b matches that, b also matches this)

Check whether this BitSet covers that (i.e. forall b matches that, b also matches this)

Value parameters

that

BitSet to b covered

Attributes

Returns

true if this BitSet can cover that BitSet

Source
BitPat.scala
override 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

Attributes

Returns

true if two BitSet is same.

Note

This method can be very expensive compared to ordinary == operator between two Objects

Definition Classes
Any
Source
BitPat.scala
def getWidth: Int

Get specified width of said BitSet

Get specified width of said BitSet

Attributes

Source
BitPat.scala
def intersect(that: BitSet): BitSet

Intersect this and that BitSet.

Intersect this and that BitSet.

Value parameters

that

BitSet to be intersected.

Attributes

Returns

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

Source
BitPat.scala
def inverse: BitSet

Calculate the inverse of this pattern set.

Calculate the inverse of this pattern set.

Attributes

Returns

A BitSet matching all value (of the given with) iff it doesn't match this pattern.

Source
BitPat.scala
def isEmpty: Boolean

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

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

Attributes

Source
BitPat.scala
def matches(input: UInt): Bool

Attributes

Source
BitPat.scala
def overlap(that: BitSet): Boolean

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

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

Value parameters

that

BitSet to be checked.

Attributes

Returns

true if this and that BitSet have overlap.

Source
BitPat.scala
def subtract(that: BitSet): BitSet

Subtract that from this BitSet.

Subtract that from this BitSet.

Value parameters

that

subtrahend BitSet.

Attributes

Returns

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

Source
BitPat.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
BitPat.scala
def union(that: BitSet): BitSet

Union this and that BitSet

Union this and that BitSet

Value parameters

that

BitSet to union.

Attributes

Returns

a BitSet containing all elements of this and that.

Source
BitPat.scala
Generated with