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

BitPat

chisel3.util.BitPat
See theBitPat companion object
sealed class BitPat(val value: BigInt, val mask: BigInt, val width: Int) extends BitSet

Attributes

Companion
object
Source
BitPat.scala
Graph
Supertypes
trait BitSet
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override 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

BitPat to be covered

Attributes

Returns

true if this BitSet can cover that BitSet

Definition Classes
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
BitSet -> Any
Source
BitPat.scala
override def getWidth: Int

Get specified width of said BitPat

Get specified width of said BitPat

Attributes

Definition Classes
Source
BitPat.scala
override def hashCode: Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

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

Intersect this and that BitPat.

Intersect this and that BitPat.

Value parameters

that

BitPat to be intersected.

Attributes

Returns

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

Source
BitPat.scala
override def isEmpty: Boolean

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

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

Attributes

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

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

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

Value parameters

that

BitPat to be checked.

Attributes

Returns

true if this and that BitPat have overlap.

Definition Classes
Source
BitPat.scala
def rawString: String

Generate raw string of a BitPat.

Generate raw string of a BitPat.

Attributes

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

Subtract a BitPat from this.

Subtract a BitPat from this.

Value parameters

that

subtrahend BitPat.

Attributes

Returns

a BitSet containing 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
BitSet -> Any
Source
BitPat.scala

Inherited methods

def ##(that: BitPat)(using SourceInfo): BitPat

Attributes

Inherited from:
BitPatIntf (hidden)
Source
BitPatIntf.scala
def =/=(that: UInt)(using SourceInfo): Bool

Attributes

Inherited from:
BitPatIntf (hidden)
Source
BitPatIntf.scala
def ===(that: UInt)(using SourceInfo): Bool

Attributes

Inherited from:
BitPatIntf (hidden)
Source
BitPatIntf.scala
def apply(x: Int, y: Int)(using SourceInfo): BitPat

Attributes

Inherited from:
BitPatIntf (hidden)
Source
BitPatIntf.scala
def apply(x: Int)(using SourceInfo): BitPat

Attributes

Inherited from:
BitPatIntf (hidden)
Source
BitPatIntf.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.

Inherited from:
BitSet
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.

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

Attributes

Inherited from:
BitSet
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.

Inherited from:
BitSet
Source
BitPat.scala
def terms: Set[BitPat & BitPatIntf]

Attributes

Inherited from:
BitPatIntf (hidden)
Source
BitPatIntf.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.

Inherited from:
BitSet
Source
BitPat.scala

Concrete fields

val mask: BigInt

Attributes

Source
BitPat.scala
val value: BigInt

Attributes

Source
BitPat.scala
val width: Int

Attributes

Source
BitPat.scala
Generated with