trait Num[T <: Data] extends AnyRef
Abstract trait defining operations available on numeric-like hardware data types.
- T
the underlying type of the number
- Grouped
- Alphabetic
- By Inheritance
- Num
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract def do_%(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- abstract def do_*(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- abstract def do_+(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- abstract def do_-(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- abstract def do_/(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- abstract def do_<(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- abstract def do_<=(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- abstract def do_>(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- abstract def do_>=(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
- abstract def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final macro
def
%(that: T): T
Modulo operator
Modulo operator
- that
a hardware type
- returns
the remainder of this numeric-like type divided by
that
- Note
This method generates a fully combinational divider which can result in significant cycle time and area costs.
-
final macro
def
*(that: T): T
Multiplication operator
Multiplication operator
- that
a hardware type
- returns
the product of this numeric-like type and
that
- Note
The width of the returned hardware type is
,width of this+width of that.This method generates a fully combinational multiplier which can result in significant cycle time and area costs.
-
final macro
def
+(that: T): T
Addition operator
Addition operator
- that
a hardware type
- returns
the sum of this numeric-like type and
that
- Note
The width of the returned hardware type is
max(width of this, width of that).
-
final macro
def
-(that: T): T
Subtraction operator
Subtraction operator
- that
a hardware type
- returns
the difference of this numeric-like type less
that
- Note
The width of the returned hardware type is
max(width of this, width of that) + 1.
-
final macro
def
/(that: T): T
Division operator
Division operator
- that
a hardware type
- returns
the quotient of this numeric-like type divided by
that
- To do
full rules
- Note
This method generates a fully combinational divider which can result in significant cycle time and area costs.
-
final macro
def
<(that: T): Bool
Less than operator
Less than operator
- that
a hardware type
- returns
a hardware Bool asserted if this numeric-like type is less than
that
-
final macro
def
<=(that: T): Bool
Less than or equal to operator
Less than or equal to operator
- that
a hardware type
- returns
a hardware Bool asserted if this numeric-like type is less than or equal to
that
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final macro
def
>(that: T): Bool
Greater than operator
Greater than operator
- that
a hardware component
- returns
a hardware Bool asserted if this numeric-like type is greater than
that
-
final macro
def
>=(that: T): Bool
Greater than or equal to operator
Greater than or equal to operator
- that
a hardware component
- returns
a hardware Bool asserted if this numeric-like type is greather than or equal to
that
-
final macro
def
abs(): T
Absolute value operator
Absolute value operator
- returns
a hardware type with a value equal to the absolute value of this numeric-like type
- Note
The width of the returned hardware type is unchanged, i.e., the
width of this.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def do_max(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- def do_min(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
-
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 macro
def
max(that: T): T
Maximum operator
Maximum operator
- that
a hardware type
- returns
a hardware type with a value equal to the mimimum value of this numeric-like type and
that
- Note
The width of the returned hardware type is
max(width of this, width of that).
-
final macro
def
min(that: T): T
Minimum operator
Minimum operator
- that
a hardware numeric-like type
- returns
a hardware type with a value equal to the mimimum value of this numeric-like type and
that
- Note
The width of the returned hardware type is
max(width of this, width of that).
-
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()
Arithmetic
Arithmetic hardware operators
Comparison
Comparison hardware operators
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 typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.