chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package aop
  Definition Classes
    chisel3
-  package choice

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  Definition Classes
    chisel3
-  package connectable
  Definition Classes
    chisel3
-  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 interface
  Definition Classes
    chisel3
-  package ltl
  Definition Classes
    chisel3
-  package naming
  Definition Classes
    chisel3
-  package probe
  Definition Classes
    chisel3
-  package properties

  The properties package includes functionality related to non-hardware data.

  The properties package includes functionality related to non-hardware data.

  This entire package is currently very experimental, so expect some rough edges and rapid API evolution.

  Definition Classes
    chisel3
-  package reflect
  Definition Classes
    chisel3
-  package simulator
  Definition Classes
    chisel3
-  package stage
  Definition Classes
    chisel3
-  package std
  Definition Classes
    chisel3
-  package testers

  The testers package provides the basic interface for chisel testers.

  The testers package provides the basic interface for chisel testers.

  Definition Classes
    chisel3
-  package util

  The util package provides extensions to core chisel for common hardware components and utility functions

  The util package provides extensions to core chisel for common hardware components and utility functions

  Definition Classes
    chisel3
- ActualDirection
- Aggregate
- AliasedAggregateFieldException
- AsyncReset
- AutoClonetypeException
- BiConnectException
- Binary
- BindingException
- Bits
- Bits
- BlackBox
- Bool
- Bool
- BoolFactory
- BuildInfo
- Bundle
- Character
- ChiselEnum
- ChiselException
- Clock
- Const
- Data
- Decimal
- Disable
- DontCare
- Element
- EnumType
- ExpectedAnnotatableException
- ExpectedChiselTypeException
- ExpectedHardwareException
- FirrtlFormat
- FixedIOBaseModule
- FixedIOExtModule
- FixedIORawModule
- FlatIO
- Flipped
- FullName
- HasTarget
- Hexadecimal
- IO
- IgnoreSeqInBundle
- ImplicitClock
- ImplicitReset
- Input
- InstanceId
- InternalErrorException
- KnownWidth
- Mem
- MemBase
- MixedDirectionAggregateException
- Module
- ModuleAspect
- MonoConnectException
- Mux
- Name
- Num
- NumObject
- Output
- PString
- Percent
- Printable
- PrintableHelper
- Printables
- RawModule
- RebindingException
- Record
- Reg
- RegInit
- RegNext
- RequireAsyncReset
- RequireSyncReset
- Reset
- ResetType
- SInt
- SInt
- SIntFactory
- SourceInfoDoc
- SpecifiedDirection
- SyncReadMem
- UInt
- UInt
- UIntFactory
- UnknownWidth
- Vec
- Vec
- VecFactory
- VecInit
- VecLike
- VerifPrintMacrosDoc
- VerificationStatement
- WhenContext
- Width
- Wire
- WireDefault
- WireFactory
- WireInit
- assert
- assume
- chiselTypeOf
- cover
- dontTouch
- emitVerilog
- fromBigIntToLiteral
- fromBooleanToLiteral
- fromIntToLiteral
- fromIntToWidth
- fromLongToLiteral
- fromStringToLiteral
- getVerilogString
- layer
- printf
- stop
- suppressEnumCastWarning
- when
- withClock
- withClockAndReset
- withDisable
- withReset
- withoutIO

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. Protected

### 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(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def do_apply[T <: Data](elt0: T, elts: T*)(implicit sourceInfo: SourceInfo): Vec[T]

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

10.  def do_fill[T <: Data](n: Int, m: Int, p: Int)(gen: => T)(implicit sourceInfo: SourceInfo): Vec[Vec[Vec[T]]]

11.  def do_fill[T <: Data](n: Int, m: Int)(gen: => T)(implicit sourceInfo: SourceInfo): Vec[Vec[T]]

12.  def do_fill[T <: Data](n: Int)(gen: => T)(implicit sourceInfo: SourceInfo): Vec[T]

13.  def do_iterate[T <: Data](start: T, len: Int)(f: (T) => T)(implicit sourceInfo: SourceInfo): Vec[T]

14.  def do_tabulate[T <: Data](n: Int, m: Int, p: Int)(gen: (Int, Int, Int) => T)(implicit sourceInfo: SourceInfo): Vec[Vec[Vec[T]]]

15.  def do_tabulate[T <: Data](n: Int, m: Int)(gen: (Int, Int) => T)(implicit sourceInfo: SourceInfo): Vec[Vec[T]]

16.  def do_tabulate[T <: Data](n: Int)(gen: (Int) => T)(implicit sourceInfo: SourceInfo): Vec[T]

17.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  def equals(arg0: AnyRef): 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.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
23.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
24.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
25.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
26.  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

27.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
28.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
29.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
30.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
31.  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

32.  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

33.  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

34.  def toString(): String
    Definition Classes
      AnyRef → Any
35.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
36.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
37.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### 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 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.