Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package experimental

    Package for experimental features, which may have their API changed, be removed, etc.

    Package for experimental features, which may have their API changed, be removed, etc.

    Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

    Definition Classes
    chisel3
  • package dataview
    Definition Classes
    experimental
  • DataProduct
  • DataView
  • DataViewable
  • InvalidViewException
  • LowPriorityDataProduct
  • PartialDataView
  • RecordUpcastable

trait DataProduct[-A] extends AnyRef

Typeclass interface for getting elements of type Data

This is needed for validating DataViews targeting type A. Can be thought of as "can be the Target of a DataView".

Chisel provides some implementations in object DataProduct that are available by default in the implicit scope.

A

Type that has elements of type Data

Annotations
@implicitNotFound()
Source
DataProduct.scala
See also

Detailed Documentation

Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataProduct
  2. AnyRef
  3. Any
Implicitly
  1. by DataViewable
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def dataIterator(a: A, path: String): Iterator[(Data, String)]

    Provides Data elements within some containing object

    Provides Data elements within some containing object

    a

    Containing object

    path

    Hierarchical path to current signal (for error reporting)

    returns

    Data elements and associated String paths (Strings for error reporting only!)

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 DataProduct[A] toany2stringadd[DataProduct[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DataProduct[A], B)
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toArrowAssoc[DataProduct[A]] 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 dataSet(a: A): (Data) => Boolean

    Returns a checker to test if the containing object contains a Data object

    Returns a checker to test if the containing object contains a Data object

    a

    Containing object

    returns

    A checker that itself returns True if a given Data is contained in a as determined by an == test

    Note

    Implementers may want to override if iterating on all Data is expensive for A and A will primarily be used in PartialDataViews

    ,

    The returned value is a function, not a true Set, but is describing the functionality of Set containment

  9. def ensuring(cond: (DataProduct[A]) => Boolean, msg: => Any): DataProduct[A]
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toEnsuring[DataProduct[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (DataProduct[A]) => Boolean): DataProduct[A]
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toEnsuring[DataProduct[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): DataProduct[A]
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toEnsuring[DataProduct[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): DataProduct[A]
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toEnsuring[DataProduct[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  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 hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def viewAs[V <: Data](implicit dataproduct: DataProduct[DataProduct[A]], dataView: DataView[DataProduct[A], V], sourceInfo: SourceInfo): V
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toDataViewable[DataProduct[A]] performed by method DataViewable in chisel3.experimental.dataview.
    Definition Classes
    DataViewable
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. 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 DataProduct[A] toStringFormat[DataProduct[A]] 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): (DataProduct[A], B)
    Implicit
    This member is added by an implicit conversion from DataProduct[A] toArrowAssoc[DataProduct[A]] 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 DataViewable fromDataProduct[A] to DataViewable[DataProduct[A]]

Inherited by implicit conversion any2stringadd fromDataProduct[A] to any2stringadd[DataProduct[A]]

Inherited by implicit conversion StringFormat fromDataProduct[A] to StringFormat[DataProduct[A]]

Inherited by implicit conversion Ensuring fromDataProduct[A] to Ensuring[DataProduct[A]]

Inherited by implicit conversion ArrowAssoc fromDataProduct[A] to ArrowAssoc[DataProduct[A]]

Ungrouped