object Interval extends NumObject
Factory and convenience methods for the Interval class IMPORTANT: The API provided here is experimental and may change in the future.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- Source
- Bits.scala
- Alphabetic
- By Inheritance
- Interval
- NumObject
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 Lit(value: BigInt, range: IntervalRange): Interval
- Attributes
- protected[chisel3]
- def Lit(value: BigInt, width: Width, binaryPoint: BinaryPoint): Interval
- Attributes
- protected[chisel3]
- val MaxBitsBigIntToBigDecimal: Int
- Definition Classes
- NumObject
- val MaxBitsBigIntToDouble: Int
- Definition Classes
- NumObject
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBigDecimal(value: BigInt, binaryPoint: BinaryPoint): BigDecimal
converts a bigInt with the given binaryPoint into the BigDecimal representation
converts a bigInt with the given binaryPoint into the BigDecimal representation
- value
a bigint
- binaryPoint
the implied binaryPoint of @i
- Definition Classes
- NumObject
- def toBigDecimal(value: BigInt, binaryPoint: Int): BigDecimal
converts a bigInt with the given binaryPoint into the BigDecimal representation
converts a bigInt with the given binaryPoint into the BigDecimal representation
- value
a bigint
- binaryPoint
the implied binaryPoint of @i
- Definition Classes
- NumObject
- def toBigInt(value: BigDecimal, binaryPoint: BinaryPoint): BigInt
How to create a bigint from a big decimal with a specific binaryPoint
How to create a bigint from a big decimal with a specific binaryPoint
- value
a BigDecimal value
- binaryPoint
a binaryPoint that you would like to use
- Definition Classes
- NumObject
- def toBigInt(x: BigDecimal, binaryPoint: Int): BigInt
How to create a bigint from a big decimal with a specific binaryPoint (int)
How to create a bigint from a big decimal with a specific binaryPoint (int)
- x
a BigDecimal value
- binaryPoint
a binaryPoint that you would like to use
- Definition Classes
- NumObject
- def toBigInt(x: Double, binaryPoint: BinaryPoint): BigInt
How to create a bigint from a big decimal with a specific binaryPoint
How to create a bigint from a big decimal with a specific binaryPoint
- x
a BigDecimal value
- binaryPoint
a binaryPoint that you would like to use
- Definition Classes
- NumObject
- def toBigInt(x: Double, binaryPoint: Int): BigInt
How to create a bigint from a double with a specific binaryPoint
How to create a bigint from a double with a specific binaryPoint
- x
a double value
- binaryPoint
a binaryPoint that you would like to use
- Definition Classes
- NumObject
- def toDouble(value: BigInt, binaryPoint: BinaryPoint): Double
converts a bigInt with the given binaryPoint into the double representation
converts a bigInt with the given binaryPoint into the double representation
- value
a bigint
- binaryPoint
the implied binaryPoint of @i
- Definition Classes
- NumObject
- def toDouble(i: BigInt, binaryPoint: Int): Double
converts a bigInt with the given binaryPoint into the double representation
converts a bigInt with the given binaryPoint into the double representation
- i
a bigint
- binaryPoint
the implied binaryPoint of @i
- Definition Classes
- NumObject
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def Zero(range: IntervalRange): Interval
Creates an Interval zero that supports the given range Useful for creating a Interval register that has a desired number of bits
Creates an Interval zero that supports the given range Useful for creating a Interval register that has a desired number of bits
val myRegister = RegInit(Interval.Zero(r"[0,12]")
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def Zero: Interval
Creates a Interval connected to a Interval literal with the value zero
Creates a Interval connected to a Interval literal with the value zero
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def apply(range: IntervalRange): Interval
Create an Interval type with specified range.
Create an Interval type with specified range.
- range
defines the properties
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def apply(width: Width, binaryPoint: BinaryPoint): Interval
Create an Interval type with specified width and binary point
Create an Interval type with specified width and binary point
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def apply(width: Width): Interval
Create an Interval type with specified width.
Create an Interval type with specified width.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def apply(binaryPoint: BinaryPoint): Interval
Create an Interval type with specified width.
Create an Interval type with specified width.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def apply(): Interval
Create an Interval type with inferred width and binary point.
Create an Interval type with inferred width and binary point.
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def fromBigDecimal(value: Double, dummy: PrivateType = PrivateObject, width: Width, binaryPoint: BinaryPoint): Interval
Create an Interval literal with inferred width from Double.
Create an Interval literal with inferred width from Double. Use PrivateObject to force users to specify width and binaryPoint by name
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def fromBigInt(value: BigInt, width: Width = Width(), binaryPoint: BinaryPoint = 0.BP): Interval
Make an interval from this BigInt, the BigInt is treated as bits So lower binaryPoint number of bits will treated as mantissa
Make an interval from this BigInt, the BigInt is treated as bits So lower binaryPoint number of bits will treated as mantissa
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def fromDouble(value: Double, dummy: PrivateType = PrivateObject, width: Width, binaryPoint: BinaryPoint): Interval
Create an Interval literal with inferred width from Double.
Create an Interval literal with inferred width from Double. Use PrivateObject to force users to specify width and binaryPoint by name
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def getLargestLegalLit(range: IntervalRange): Option[Interval]
This returns the largest Interval literal that can legally fit in range, if possible If the upper bound or binary point is not known then return None
This returns the largest Interval literal that can legally fit in range, if possible If the upper bound or binary point is not known then return None
- range
use to figure low number
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- def getSmallestLegalLit(range: IntervalRange): Option[Interval]
This returns the smallest Interval literal that can legally fit in range, if possible If the lower bound or binary point is not known then return None
This returns the smallest Interval literal that can legally fit in range, if possible If the lower bound or binary point is not known then return None
- range
use to figure low number
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
- object Implicits
Contains the implicit classes used to provide the .I methods to create intervals from the standard numberic types.
Contains the implicit classes used to provide the .I methods to create intervals from the standard numberic types.
val x = 7.I val y = 7.5.I(4.BP)
- Annotations
- @deprecated
- Deprecated
(Since version Chisel 3.6) this feature will not be supported as part of the migration to the MLIR-based FIRRTL Compiler (MFC). For more information about this migration, please see the Chisel ROADMAP.md.
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.