Packages

o

Chisel

Enum

object Enum extends Enum

Source
compatibility.scala
Linear Supertypes
Enum, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Enum
  2. Enum
  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. def apply[T <: Bits](nodeType: T, n: Int): List[T]

    Returns n unique values of the specified type.

    Returns n unique values of the specified type. Can be used with unpacking to define enums.

    nodeType must be of UInt type (note that Bits() creates a UInt) with unspecified width.

    Example: 

    1. val state_on :: state_off :: Nil = Enum(UInt(), 2)
val current_state = UInt()
switch (current_state) {
  is (state_on) {
     ...
  }
  if (state_off) {
     ...
  }
}
  5. def apply(n: Int): List[chisel3.UInt]

    Returns n unique UInt values

    Returns n unique UInt values

    n

    Number of unique UInt constants to enumerate

    returns

    Enumerated constants

    Definition Classes
    Enum
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def createValues(n: Int): Seq[chisel3.UInt]

    Returns a sequence of Bits subtypes with values from 0 until n.

    Returns a sequence of Bits subtypes with values from 0 until n. Helper method.

    Attributes
    protected
    Definition Classes
    Enum
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. def apply[T <: Bits](nodeType: T, l: List[Symbol]): Map[Symbol, T]

    An old Enum API that returns a map of symbols to UInts.

    An old Enum API that returns a map of symbols to UInts.

    Unlike the new list-based Enum, which can be unpacked into vals that the compiler understands and can check, map accesses can't be compile-time checked and typos may not be caught until runtime.

    Despite being deprecated, this is not to be removed from the compatibility layer API. Deprecation is only to nag users to do something safer.

    Annotations
    @deprecated
    Deprecated

    (Since version not soon enough) Use list-based Enum

  2. def apply[T <: Bits](nodeType: T, l: Symbol*): Map[Symbol, T]

    An old Enum API that returns a map of symbols to UInts.

    An old Enum API that returns a map of symbols to UInts.

    Unlike the new list-based Enum, which can be unpacked into vals that the compiler understands and can check, map accesses can't be compile-time checked and typos may not be caught until runtime.

    Despite being deprecated, this is not to be removed from the compatibility layer API. Deprecation is only to nag users to do something safer.

    Annotations
    @deprecated
    Deprecated

    (Since version not soon enough) Use list-based Enum

Inherited from Enum

Inherited from AnyRef

Inherited from Any

Ungrouped