object Enum extends Enum
- Source
- compatibility.scala
- Alphabetic
- By Inheritance
- Enum
- Enum
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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.
val state_on :: state_off :: Nil = Enum(UInt(), 2) val current_state = UInt() switch (current_state) { is (state_on) { ... } if (state_off) { ... } }
Example: -
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Deprecated Value Members
-
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
-
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
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
,FixedPoint
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.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.