implicit class DataEquality[T <: Data] extends AnyRef
Provides generic, recursive equality for Bundle and Vec hardware. This avoids the
need to use workarounds such as bundle1.asUInt === bundle2.asUInt by allowing users
to instead write bundle1 === bundle2.
Static type safety of this comparison is guaranteed at compile time as the extension
method requires the same parameterized type for both the left-hand and right-hand
sides. It is, however, possible to get around this type safety using Bundle subtypes
that can differ during runtime (e.g. through a generator). These cases are
subsequently raised as elaboration errors.
- Source
- Data.scala
- Alphabetic
- By Inheritance
- DataEquality
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DataEquality(lhs: T)(implicit sourceInfo: SourceInfo)
- lhs
The Data hardware on the left-hand side of the equality
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toany2stringadd[DataEquality[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DataEquality[T], B)
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toArrowAssoc[DataEquality[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===(rhs: T): Bool
Dynamic recursive equality operator for generic Data
Dynamic recursive equality operator for generic Data
- Exceptions thrown
ChiselExceptionwhenlhsandrhsare different types during elaboration time
- 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 ensuring(cond: (DataEquality[T]) => Boolean, msg: => Any): DataEquality[T]
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DataEquality[T]) => Boolean): DataEquality[T]
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DataEquality[T]
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DataEquality[T]
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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 hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toStringFormat[DataEquality[T]] 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): (DataEquality[T], B)
- Implicit
- This member is added by an implicit conversion from DataEquality[T] toArrowAssoc[DataEquality[T]] 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.