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

object DataView extends InvertibleDataView

Factory methods for constructing DataViews, see class for example use

Source
DataView.scala
Linear Supertypes
dataview.InvertibleDataView, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataView
  2. InvertibleDataView
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class InvertibleDataView[T <: Data, V <: Data] extends AnyRef

    Provides invert for invertible DataViews

    Provides invert for invertible DataViews

    This must be done as an extension method because it applies an addition constraint on the Target type parameter, namely that it must be a subtype of Data.

    Definition Classes
    InvertibleDataView
    Note

    PartialDataViews are **not** invertible and will result in an elaboration time exception

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply[T, V <: Data](mkView: (T) => V, pairs: (T, V) => (Data, Data)*)(implicit arg0: DataProduct[T], sourceInfo: SourceInfo): DataView[T, V]

    Default factory method, alias for pairs

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. implicit def identityView[A <: Data](implicit sourceInfo: SourceInfo): DataView[A, A]

    All Chisel Data are viewable as their own type

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def mapping[T, V <: Data](mkView: (T) => V, mapping: (T, V) => Iterable[(Data, Data)])(implicit arg0: DataProduct[T], sourceInfo: SourceInfo): DataView[T, V]

    More general factory method for complex mappings

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def pairs[T, V <: Data](mkView: (T) => V, pairs: (T, V) => (Data, Data)*)(implicit arg0: DataProduct[T], sourceInfo: SourceInfo): DataView[T, V]

    Construct DataViews with pairs of functions from the target and view to corresponding fields

  19. implicit def seqDataView[A, B <: Data](implicit arg0: DataProduct[A], dv: DataView[A, B], sourceInfo: SourceInfo): DataView[Seq[A], Vec[B]]

    Provides DataView[Seq[A], Vec[B]] for all A such that there exists DataView[A, B]

  20. def swapArgs[A, B, C, D](f: (A, B) => Iterable[(C, D)]): (B, A) => Iterable[(D, C)]
    Definition Classes
    InvertibleDataView
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. implicit def tuple10DataView[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data, V5 <: Data, V6 <: Data, V7 <: Data, V8 <: Data, V9 <: Data, V10 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], arg4: DataProduct[T5], arg5: DataProduct[T6], arg6: DataProduct[T7], arg7: DataProduct[T8], arg8: DataProduct[T9], arg9: DataProduct[T10], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], v5: DataView[T5, V5], v6: DataView[T6, V6], v7: DataView[T7, V7], v8: DataView[T8, V8], v9: DataView[T9, V9], v10: DataView[T10, V10], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10), HWTuple10[V1, V2, V3, V4, V5, V6, V7, V8, V9, V10]]

    Provides implementations of DataView for scala.Tuple10 to HWTuple10

  24. implicit def tuple2DataView[T1, T2, V1 <: Data, V2 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], v1: DataView[T1, V1], v2: DataView[T2, V2], sourceInfo: SourceInfo): DataView[(T1, T2), HWTuple2[V1, V2]]

    Provides implementations of DataView for scala.Tuple2 to HWTuple2

  25. implicit def tuple3DataView[T1, T2, T3, V1 <: Data, V2 <: Data, V3 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], sourceInfo: SourceInfo): DataView[(T1, T2, T3), HWTuple3[V1, V2, V3]]

    Provides implementations of DataView for scala.Tuple3 to HWTuple3

  26. implicit def tuple4DataView[T1, T2, T3, T4, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4), HWTuple4[V1, V2, V3, V4]]

    Provides implementations of DataView for scala.Tuple4 to HWTuple4

  27. implicit def tuple5DataView[T1, T2, T3, T4, T5, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data, V5 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], arg4: DataProduct[T5], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], v5: DataView[T5, V5], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4, T5), HWTuple5[V1, V2, V3, V4, V5]]

    Provides implementations of DataView for scala.Tuple5 to HWTuple5

  28. implicit def tuple6DataView[T1, T2, T3, T4, T5, T6, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data, V5 <: Data, V6 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], arg4: DataProduct[T5], arg5: DataProduct[T6], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], v5: DataView[T5, V5], v6: DataView[T6, V6], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4, T5, T6), HWTuple6[V1, V2, V3, V4, V5, V6]]

    Provides implementations of DataView for scala.Tuple6 to HWTuple6

  29. implicit def tuple7DataView[T1, T2, T3, T4, T5, T6, T7, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data, V5 <: Data, V6 <: Data, V7 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], arg4: DataProduct[T5], arg5: DataProduct[T6], arg6: DataProduct[T7], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], v5: DataView[T5, V5], v6: DataView[T6, V6], v7: DataView[T7, V7], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4, T5, T6, T7), HWTuple7[V1, V2, V3, V4, V5, V6, V7]]

    Provides implementations of DataView for scala.Tuple7 to HWTuple7

  30. implicit def tuple8DataView[T1, T2, T3, T4, T5, T6, T7, T8, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data, V5 <: Data, V6 <: Data, V7 <: Data, V8 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], arg4: DataProduct[T5], arg5: DataProduct[T6], arg6: DataProduct[T7], arg7: DataProduct[T8], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], v5: DataView[T5, V5], v6: DataView[T6, V6], v7: DataView[T7, V7], v8: DataView[T8, V8], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4, T5, T6, T7, T8), HWTuple8[V1, V2, V3, V4, V5, V6, V7, V8]]

    Provides implementations of DataView for scala.Tuple8 to HWTuple8

  31. implicit def tuple9DataView[T1, T2, T3, T4, T5, T6, T7, T8, T9, V1 <: Data, V2 <: Data, V3 <: Data, V4 <: Data, V5 <: Data, V6 <: Data, V7 <: Data, V8 <: Data, V9 <: Data](implicit arg0: DataProduct[T1], arg1: DataProduct[T2], arg2: DataProduct[T3], arg3: DataProduct[T4], arg4: DataProduct[T5], arg5: DataProduct[T6], arg6: DataProduct[T7], arg7: DataProduct[T8], arg8: DataProduct[T9], v1: DataView[T1, V1], v2: DataView[T2, V2], v3: DataView[T3, V3], v4: DataView[T4, V4], v5: DataView[T5, V5], v6: DataView[T6, V6], v7: DataView[T7, V7], v8: DataView[T8, V8], v9: DataView[T9, V9], sourceInfo: SourceInfo): DataView[(T1, T2, T3, T4, T5, T6, T7, T8, T9), HWTuple9[V1, V2, V3, V4, V5, V6, V7, V8, V9]]

    Provides implementations of DataView for scala.Tuple9 to HWTuple9

  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()

Inherited from dataview.InvertibleDataView

Inherited from AnyRef

Inherited from Any

Ungrouped