Packages

o

chisel3

VecInit

object VecInit extends SourceInfoDoc

Source
Aggregate.scala
Linear Supertypes
SourceInfoDoc, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. VecInit
  2. SourceInfoDoc
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. macro def apply[T <: Data](elt0: T, elts: T*): Vec[T]

    Creates a new Vec composed of the input Data nodes.

    Creates a new Vec composed of the input Data nodes.

    Note

    input elements should be of the same type (this is checked at the FIRRTL level, but not at the Scala / Chisel level)

    ,

    the width of all output elements is the width of the largest input element

    ,

    output elements are connected from the input elements

  5. macro def apply[T <: Data](elts: Seq[T]): Vec[T]

    Creates a new Vec composed of elements of the input Seq of Data nodes.

    Creates a new Vec composed of elements of the input Seq of Data nodes.

    Note

    input elements should be of the same type (this is checked at the FIRRTL level, but not at the Scala / Chisel level)

    ,

    the width of all output elements is the width of the largest input element

    ,

    output elements are connected from the input elements

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def do_apply[T <: Data](elt0: T, elts: T*)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[T]

  9. def do_apply[T <: Data](elts: Seq[T])(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[T]

  10. def do_fill[T <: Data](n: Int, m: Int, p: Int)(gen: ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[Vec[Vec[T]]]

  11. def do_fill[T <: Data](n: Int, m: Int)(gen: ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[Vec[T]]

  12. def do_fill[T <: Data](n: Int)(gen: ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[T]

  13. def do_iterate[T <: Data](start: T, len: Int)(f: (T) ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[T]

  14. def do_tabulate[T <: Data](n: Int, m: Int, p: Int)(gen: (Int, Int, Int) ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[Vec[Vec[T]]]

  15. def do_tabulate[T <: Data](n: Int, m: Int)(gen: (Int, Int) ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[Vec[T]]

  16. def do_tabulate[T <: Data](n: Int)(gen: (Int) ⇒ T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Vec[T]

  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. macro def fill[T <: Data](n: Int, m: Int, p: Int)(gen: ⇒ T): Vec[Vec[Vec[T]]]

    Creates a new 3D Vec of length n by m by p composed of the result of the given function applied to an element of data type T.

    Creates a new 3D Vec of length n by m by p composed of the result of the given function applied to an element of data type T.

    n

    number of 2D vectors inside outer vector

    m

    number of 1D vectors in each 2D vector

    p

    number of elements in each 1D vector

    gen

    function that takes in an element T and returns an output element of the same type

  20. macro def fill[T <: Data](n: Int, m: Int)(gen: ⇒ T): Vec[Vec[T]]

    Creates a new 2D Vec of length n by m composed of the result of the given function applied to an element of data type T.

    Creates a new 2D Vec of length n by m composed of the result of the given function applied to an element of data type T.

    n

    number of inner vectors (rows) in the outer vector

    m

    number of elements in each inner vector (column)

    gen

    function that takes in an element T and returns an output element of the same type

  21. macro def fill[T <: Data](n: Int)(gen: ⇒ T): Vec[T]

    Creates a new Vec of length n composed of the result of the given function applied to an element of data type T.

    Creates a new Vec of length n composed of the result of the given function applied to an element of data type T.

    n

    number of elements in the vector

    gen

    function that takes in an element T and returns an output element of the same type

  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. macro def iterate[T <: Data](start: T, len: Int)(f: (T) ⇒ T): Vec[T]

    Creates a new Vec of length n composed of the result of the given function applied to an element of data type T.

    Creates a new Vec of length n composed of the result of the given function applied to an element of data type T.

    start

    First element in the Vec

    len

    Lenth of elements in the Vec

    f

    Function that applies the element T from previous index and returns the output element to the next index

  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. macro def tabulate[T <: Data](n: Int, m: Int, p: Int)(gen: (Int, Int, Int) ⇒ T): Vec[Vec[Vec[T]]]

    Creates a new 3D Vec of length n by m by p composed of the results of the given function applied over a range of integer values starting from 0.

    Creates a new 3D Vec of length n by m by p composed of the results of the given function applied over a range of integer values starting from 0.

    n

    number of 2D vectors inside outer vector

    m

    number of 1D vectors in each 2D vector

    p

    number of elements in each 1D vector

    gen

    function that takes in an Int (the index) and returns a Data that becomes the output element

  31. macro def tabulate[T <: Data](n: Int, m: Int)(gen: (Int, Int) ⇒ T): Vec[Vec[T]]

    Creates a new 2D Vec of length n by m composed of the results of the given function applied over a range of integer values starting from 0.

    Creates a new 2D Vec of length n by m composed of the results of the given function applied over a range of integer values starting from 0.

    n

    number of 1D vectors inside outer vector

    m

    number of elements in each 1D vector (the function is applied from 0 to n-1)

    gen

    function that takes in an Int (the index) and returns a Data that becomes the output element

  32. macro def tabulate[T <: Data](n: Int)(gen: (Int) ⇒ T): Vec[T]

    Creates a new Vec of length n composed of the results of the given function applied over a range of integer values starting from 0.

    Creates a new Vec of length n composed of the results of the given function applied over a range of integer values starting from 0.

    n

    number of elements in the vector (the function is applied from 0 to n-1)

    gen

    function that takes in an Int (the index) and returns a Data that becomes the output element

  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from SourceInfoDoc

Inherited from AnyRef

Inherited from Any

Ungrouped

SourceInfoTransformMacro

These internal methods are not part of the public-facing API!

The equivalent public-facing methods do not have the do_ prefix or have the same name. Use and look at the documentation for those. If you want left shift, use <<, not do_<<. If you want conversion to a Seq of Bools look at the asBools above, not the one below. Users can safely ignore every method in this group!

🐉🐉🐉 Here be dragons... 🐉🐉🐉

These do_X methods are used to enable both implicit passing of SourceInfo and chisel3.CompileOptions while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your designs, are converted to their "hidden", do_*, via macro transformations. Without using macros here, only one of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a chained apply as an explicit 'implicit' argument and will throw type errors.

The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method into a call to an internal, hidden do_* that takes an explicit SourceInfo by inserting an implicitly[SourceInfo] as the explicit argument.