Packages

class AFix extends MultiData with Num[AFix] with BitwiseOp[AFix] with MinMaxDecimalProvider

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AFix
  2. MinMaxDecimalProvider
  3. BitwiseOp
  4. Num
  5. MultiData
  6. Data
  7. InComponent
  8. OverridedEqualsHashCode
  9. SpinalTagReady
  10. Assignable
  11. NameableByComponent
  12. Nameable
  13. OwnableRef
  14. ContextUser
  15. ScalaLocated
  16. GlobalDataUser
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AFix(maxRaw: BigInt, minRaw: BigInt, exp: Int)

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. def !=(right: AFix): Bool
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. def #*(count: Int): Bits
    Definition Classes
    Data
  6. def %(right: AFix): AFix

    Divides this by the right hand side AFix value expanding ranges as necessary

    Divides this by the right hand side AFix value expanding ranges as necessary

    right

    Value to divide this by

    returns

    Remainder

    Definition Classes
    AFixNum
  7. def &(right: AFix): AFix

    Logical AND operator

    Logical AND operator

    Definition Classes
    AFixBitwiseOp
  8. def *(right: AFix): AFix

    Mutiplies this by the right hand side AFix value expanding ranges as necessary

    Mutiplies this by the right hand side AFix value expanding ranges as necessary

    right

    Value to multiply this by

    returns

    Product

    Definition Classes
    AFixNum
  9. def +(right: AFix): AFix

    Adds this to the right hand side AFix value expanding ranges as necessary

    Adds this to the right hand side AFix value expanding ranges as necessary

    right

    Value to add to this

    returns

    Sum

    Definition Classes
    AFixNum
  10. def +^(right: AFix): AFix

    Safe Addition with 1 bit expand

    Safe Addition with 1 bit expand

    Definition Classes
    AFixNum
  11. def +|(right: AFix): AFix

    Adds this to the right hand side AFix value without expanding ranges or checks on value overflow

    Adds this to the right hand side AFix value without expanding ranges or checks on value overflow

    right

    Value to add to this

    returns

    Sum

    Definition Classes
    AFixNum
  12. def -(right: AFix): AFix

    Subtracts this to the right hand side AFix value expanding ranges as necessary

    Subtracts this to the right hand side AFix value expanding ranges as necessary

    right

    Value to subtract from this

    returns

    Difference

    Definition Classes
    AFixNum
  13. def -^(right: AFix): AFix

    Safe Substraction with 1 bit expand

    Safe Substraction with 1 bit expand

    Definition Classes
    AFixNum
  14. def -|(right: AFix): AFix

    Subtracts this from the right hand side AFix value without expanding ranges or checks on value underflow

    Subtracts this from the right hand side AFix value without expanding ranges or checks on value underflow

    right

    Value to subtract from this

    returns

    Difference

    Definition Classes
    AFixNum
  15. def /(right: AFix): AFix

    Divides this by the right hand side AFix value expanding ranges as necessary

    Divides this by the right hand side AFix value expanding ranges as necessary

    right

    Value to divide this by

    returns

    Quotient

    Definition Classes
    AFixNum
  16. def :=(that: BigDecimal): Unit
  17. def :=(a: AFix): Unit
  18. def :=(s: SFix): Unit
  19. def :=(u: UFix): Unit
  20. def :=(s: SInt): Unit
  21. def :=(u: UInt): Unit
  22. def <(right: AFix): Bool

    Is less than right

    Is less than right

    Definition Classes
    AFixNum
  23. def <<(shift: Int): AFix

    Logical left shift (w(T) = w(this) + shift)

    Logical left shift (w(T) = w(this) + shift)

    Definition Classes
    AFixNum
  24. def <<|(shift: Int): AFix
  25. def <=(right: AFix): Bool

    Is equal or less than right

    Is equal or less than right

    Definition Classes
    AFixNum
  26. def =/=(right: AFix): Bool
  27. def ==(right: AFix): Bool
  28. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def ===(right: AFix): Bool
  30. def >(right: AFix): Bool

    Is greater than right

    Is greater than right

    Definition Classes
    AFixNum
  31. def >=(right: AFix): Bool

    Is equal or greater than right

    Is equal or greater than right

    Definition Classes
    AFixNum
  32. def >>(shift: AFix): AFix
  33. def >>(shift: Int): AFix

    Logical right shift (w(T) = w(this) - shift)

    Logical right shift (w(T) = w(this) - shift)

    Definition Classes
    AFixNum
  34. def >>|(shift: AFix): AFix
  35. def >>|(shift: Int): AFix
  36. def Q: QFormat
    Definition Classes
    AFixNum
  37. def ^(right: AFix): AFix

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    AFixBitwiseOp
  38. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  39. def addAttribute(attribute: Attribute): AFix.this.type
    Definition Classes
    DataSpinalTagReady
  40. def addAttribute(name: String, value: Int): AFix.this.type
    Definition Classes
    SpinalTagReady
  41. def addAttribute(name: String, value: String): AFix.this.type
    Definition Classes
    SpinalTagReady
  42. def addAttribute(name: String): AFix.this.type
    Definition Classes
    SpinalTagReady
  43. def addTag[T <: SpinalTag](spinalTag: T): AFix.this.type
    Definition Classes
    MultiDataSpinalTagReady
  44. def addTags(h: SpinalTag, tail: SpinalTag*): AFix.this.type
    Definition Classes
    SpinalTagReady
  45. def addTags[T <: SpinalTag](tags: Iterable[T]): AFix.this.type
    Definition Classes
    SpinalTagReady
  46. def allowDirectionLessIo(): AFix.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

    Definition Classes
    Data
  47. def allowOverride(): AFix.this.type

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  48. def allowPartialyAssigned(): AFix.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  49. def allowPruning(): AFix.this.type
    Definition Classes
    Data
  50. def allowSimplifyIt(): AFix.this.type
    Definition Classes
    Data
  51. def allowUnsetRegToAvoidLatch(): AFix.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  52. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  53. def asAlwaysPositive(): AFix
  54. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  55. def asData: Data
    Definition Classes
    Data
  56. def asInOut(): AFix.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  57. def asInput(): AFix.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    MultiDataData
  58. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  59. def asOutput(): AFix.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  60. def asSFix(): SFix
  61. def asSInt(): SInt
  62. def asUFix(): UFix
  63. def asUInt(): UInt
  64. def assignDontCare(): AFix.this.type
    Definition Classes
    Data
  65. def assignDontCareToUnasigned(): AFix.this.type
    Definition Classes
    Data
  66. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiDataData
  67. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  68. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiDataData
  69. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiDataData
  70. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  71. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    AFixAssignable
  72. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  73. val bitWidth: Int
  74. def ceil(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  75. def ceil(exp: Int): AFix

    Rounds a value up towards positive infinity at the given exp point position

    Rounds a value up towards positive infinity at the given exp point position

    returns

    Rounded result

  76. def ceil(width: BitCount, align: Boolean): AFix

    lowest n bits Round Operation by BitCount

    lowest n bits Round Operation by BitCount

    Definition Classes
    Num
  77. def ceilToInf(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  78. def ceilToInf(exp: Int): AFix

    Rounds a value towards negative or positive infinity

    Rounds a value towards negative or positive infinity

    returns

    Rounded result

  79. def ceilToInf(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  80. def clearAll(): AFix.this.type
    Definition Classes
    Data
  81. def clone(): AFix.this.type
    Definition Classes
    AFixData → AnyRef
  82. def component: Component
    Definition Classes
    ContextUser
  83. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  84. val compositeAssign: Assignable
    Definition Classes
    Assignable
  85. def copyDirectionOfImpl(that: Data): AFix.this.type
    Definition Classes
    MultiDataData
  86. def dirString(): String
    Definition Classes
    Data
  87. def dontSimplifyIt(): AFix.this.type
    Definition Classes
    Data
  88. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    AFixMultiData
  89. def elementsString: String
    Definition Classes
    MultiData
  90. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  91. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  92. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  93. val exp: Int
  94. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  95. def find(name: String): Data
    Definition Classes
    MultiData
  96. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  97. def fixTo(Q: QFormat, roundType: RoundType): AFix
  98. def fixTo(Q: QFormat): AFix
  99. def fixTo(af: AFix): AFix
  100. def fixTo(af: AFix, roundType: RoundType): AFix
  101. def flatten: Seq[BaseType]
    Definition Classes
    MultiDataData
  102. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    MultiDataData
  103. def flattenLocalName: Seq[String]
    Definition Classes
    MultiDataData
  104. def flip(): AFix.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiDataData
  105. def floor(exp: Int): AFix

    Rounds a value down towards negative infinity (truncation) at the given exp point position

    Rounds a value down towards negative infinity (truncation) at the given exp point position

    returns

    Rounded result

    Definition Classes
    AFixNum
  106. def floor(width: BitCount): AFix
    Definition Classes
    Num
  107. def floorToZero(exp: Int): AFix

    Rounds a value towards zero

    Rounds a value towards zero

    returns

    Rounded result

    Definition Classes
    AFixNum
  108. def floorToZero(width: BitCount): AFix
    Definition Classes
    Num
  109. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  110. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  111. val fracWidth: Int
  112. def freeze(): AFix.this.type
    Definition Classes
    MultiDataData
  113. def getAheadValue(): AFix.this.type
    Definition Classes
    Data
  114. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiDataData
  115. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  116. def getComponent(): Component
    Definition Classes
    DataInComponentNameableByComponent
  117. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  118. def getDirection: IODirection
    Definition Classes
    Data
  119. def getDisplayName(): String
    Definition Classes
    Nameable
  120. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  121. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  122. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    AFixData
  123. def getName(default: String): String
    Definition Classes
    NameableByComponentNameable
  124. def getName(): String
    Definition Classes
    NameableByComponentNameable
  125. def getPartialName(): String
    Definition Classes
    Nameable
  126. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  127. def getRealSource: Any
    Definition Classes
    Assignable
  128. def getRealSourceNoRec: Any
    Definition Classes
    DataAssignable
  129. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  130. def getRootParent: Data
    Definition Classes
    Data
  131. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  132. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  133. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  134. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  135. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  136. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  137. def getZero: AFix.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  138. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  139. def hasParametersOf(that: AFix): Boolean
  140. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  141. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  142. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  143. def init(that: AFix): AFix.this.type
  144. def init(that: BigDecimal): AFix.this.type
  145. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  146. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  147. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  148. val intWidth: Int
  149. def isAnalog: Boolean
    Definition Classes
    Data
  150. def isComb: Boolean
    Definition Classes
    Data
  151. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  152. def isDirectionLess: Boolean
    Definition Classes
    Data
  153. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  154. def isInOut: Boolean
    Definition Classes
    Data
  155. def isInput: Boolean
    Definition Classes
    Data
  156. def isInputOrInOut: Boolean
    Definition Classes
    Data
  157. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  158. def isNamed: Boolean
    Definition Classes
    NameableByComponentNameable
  159. def isNegative(): Bool
  160. def isOutput: Boolean
    Definition Classes
    Data
  161. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  162. def isPositive(): Bool
  163. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  164. def isReg: Boolean
    Definition Classes
    Data
  165. def isRegOnAssign: Boolean
    Definition Classes
    Data
  166. def isUnnamed: Boolean
    Definition Classes
    Nameable
  167. def isZero(): Bool
  168. def max(right: AFix): AFix

    Return the maximum value between this and right

    Return the maximum value between this and right

    Definition Classes
    Num
  169. val maxRaw: BigInt
  170. lazy val maxValue: BigDecimal
    Definition Classes
    AFixMinMaxDecimalProvider
  171. def min(right: AFix): AFix

    Return the minimum value between this and right

    Return the minimum value between this and right

    Definition Classes
    Num
  172. val minRaw: BigInt
  173. lazy val minValue: BigDecimal
    Definition Classes
    AFixMinMaxDecimalProvider
  174. val name: String
    Definition Classes
    Nameable
  175. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  176. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  177. def negate(enable: Bool, plusOneEnable: Bool = null): AFix
  178. def negate(): AFix
  179. def noBackendCombMerge(): AFix.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  180. def noCombLoopCheck(): AFix.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  181. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  182. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  183. val numWidth: Int
  184. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  185. def overrideLocalName(name: String): AFix.this.type
    Definition Classes
    Nameable
  186. val parent: Data
    Definition Classes
    Data
  187. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  188. def pull(propagateName: Boolean): AFix.this.type
    Definition Classes
    Data
  189. def pull(): AFix.this.type

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  190. def purify(): AFix.this.type
    Definition Classes
    Data
  191. def randBoot(u: Unit): AFix.this.type

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  192. val raw: Bits
  193. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  194. def reflectNames(): Unit
    Definition Classes
    Nameable
  195. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): AFix.this.type
    Definition Classes
    Data
  196. def removeDataAssignments(): AFix.this.type
    Definition Classes
    Data
  197. def removeInitAssignments(): AFix.this.type
    Definition Classes
    Data
  198. def removeTag(spinalTag: SpinalTag): AFix.this.type
    Definition Classes
    SpinalTagReady
  199. def removeTags(tags: Iterable[SpinalTag]): AFix.this.type
    Definition Classes
    SpinalTagReady
  200. def resize(newExp: ExpNumber): AFix
  201. def resized: AFix.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  202. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  203. def rootIFList(): List[Interface]
    Definition Classes
    Data
  204. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  205. def round(exp: Int, aligned: Boolean = getTrunc.saturation): AFix
    Definition Classes
    AFixNum
  206. def round(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  207. def roundDown(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  208. def roundDown(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  209. def roundHalfDown(exp: Int): AFix

    Rounds a value down (floor/truncate) if x <= 0.5 otherwise rounds up (ceil)

    Rounds a value down (floor/truncate) if x <= 0.5 otherwise rounds up (ceil)

    returns

    Rounded result

  210. def roundHalfToEven(exp: Int): AFix

    Rounds a value towards the nearest even value including half values, otherwise rounds towards odd values

    Rounds a value towards the nearest even value including half values, otherwise rounds towards odd values

    returns

    Rounded result

  211. def roundHalfToInf(exp: Int): AFix

    Rounds a value towards infinity if x >= 0.5 otherwise rounds towards zero

    Rounds a value towards infinity if x >= 0.5 otherwise rounds towards zero

    returns

    Rounded result

  212. def roundHalfToOdd(exp: Int): AFix

    Rounds a value towards the nearest odd value including half values, otherwise rounds towards even values

    Rounds a value towards the nearest odd value including half values, otherwise rounds towards even values

    returns

    Rounded result

  213. def roundHalfToZero(exp: Int): AFix

    Rounds a value towards zero (floor/truncate) if x <= 0.5 otherwise rounds towards infinity

    Rounds a value towards zero (floor/truncate) if x <= 0.5 otherwise rounds towards infinity

    returns

    Rounded result

  214. def roundHalfUp(exp: Int): AFix

    Rounds a value up (ceiling) if x >= 0.5 otherwise rounds down (floor/truncate)

    Rounds a value up (ceiling) if x >= 0.5 otherwise rounds down (floor/truncate)

    returns

    Rounded result

  215. def roundToEven(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  216. def roundToEven(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  217. def roundToInf(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  218. def roundToInf(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  219. def roundToOdd(exp: Int, align: Boolean): AFix
    Definition Classes
    AFixNum
  220. def roundToOdd(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  221. def roundToZero(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  222. def roundToZero(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  223. def roundUp(exp: Int, aligned: Boolean): AFix
    Definition Classes
    AFixNum
  224. def roundUp(width: BitCount, align: Boolean): AFix
    Definition Classes
    Num
  225. def rounded: AFix
  226. def rounded(rounding: RoundType): AFix
  227. def sat(m: Int): AFix

    Saturates the top m bits.

    Saturates the top m bits. Other AFix specific saturation functions are recommended. This function is bit orientated unlike other AFix functions.

    m

    - Number of high bits to saturate off

    Definition Classes
    AFixNum
  228. def sat(satMax: BigInt, satMin: BigInt): AFix

    Saturates a number to a provided integer representation value range

    Saturates a number to a provided integer representation value range

    satMax

    Max integer value to saturate

    satMin

    Min integer value to saturate

    returns

    - Saturated AFix value

  229. def sat(satMax: BigInt, satMin: BigInt, exp: ExpNumber): AFix

  230. def sat(af: AFix): AFix

    Saturates a number to the range of another number.

    Saturates a number to the range of another number. This accounts for decimal shifting.

    af

    - AFix value to saturate range to

    returns

    - Saturated AFix value

  231. def sat(width: BitCount): AFix
    Definition Classes
    Num
  232. def saturated: AFix
  233. def saturated(rounding: RoundType): AFix
  234. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  235. def scrap(exp: Int): AFix
  236. def setAll(): AFix.this.type
    Definition Classes
    Data
  237. def setAsAnalog(): AFix.this.type
    Definition Classes
    Data
  238. def setAsComb(): AFix.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  239. def setAsDirectionLess(): AFix.this.type

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    MultiDataData
  240. def setAsReg(): AFix.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiDataData
  241. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): AFix.this.type
    Definition Classes
    Nameable
  242. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): AFix.this.type
    Definition Classes
    Nameable
  243. def setCompositeName(nameable: Nameable, postfix: String): AFix.this.type
    Definition Classes
    Nameable
  244. def setCompositeName(nameable: Nameable, namePriority: Byte): AFix.this.type
    Definition Classes
    Nameable
  245. def setCompositeName(nameable: Nameable, weak: Boolean): AFix.this.type
    Definition Classes
    Nameable
  246. def setCompositeName(nameable: Nameable): AFix.this.type
    Definition Classes
    Nameable
  247. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): AFix.this.type
    Definition Classes
    Nameable
  248. def setName(name: String, namePriority: Byte): AFix.this.type
    Definition Classes
    Nameable
  249. def setName(name: String, weak: Boolean): AFix.this.type
    Definition Classes
    Nameable
  250. def setName(name: String): AFix.this.type
    Definition Classes
    Nameable
  251. def setNameAsWeak(): AFix.this.type
    Definition Classes
    Nameable
  252. def setOutputAsReg(): AFix.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  253. def setPartialName(name: String, namePriority: Byte, owner: Any): AFix.this.type
    Definition Classes
    Nameable
  254. def setPartialName(name: String, namePriority: Byte): AFix.this.type
    Definition Classes
    Nameable
  255. def setPartialName(name: String, weak: Boolean): AFix.this.type
    Definition Classes
    Nameable
  256. def setPartialName(owner: Nameable, name: String, namePriority: Byte): AFix.this.type
    Definition Classes
    Nameable
  257. def setPartialName(owner: Nameable, name: String, weak: Boolean): AFix.this.type
    Definition Classes
    Nameable
  258. def setPartialName(name: String): AFix.this.type
    Definition Classes
    Nameable
  259. def setPartialName(owner: Nameable, name: String): AFix.this.type
    Definition Classes
    Nameable
  260. def setPartialName(owner: Nameable): AFix.this.type
    Definition Classes
    Nameable
  261. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  262. def setScalaLocated(source: ScalaLocated): AFix.this.type
    Definition Classes
    ScalaLocated
  263. def setWeakName(name: String): AFix.this.type
    Definition Classes
    Nameable
  264. val signWidth: Int
  265. val signed: Boolean
  266. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  267. lazy val step: BigDecimal
  268. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  269. def tag(q: QFormat): AFix

    This function differs from traditional Num[T] by returning a new AFix

    This function differs from traditional Num[T] by returning a new AFix

    Definition Classes
    AFixNum
  270. def toAFix(that: HardType[AFix]): AFix
  271. def toIo(): AFix.this.type
    Definition Classes
    Data
  272. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    AFixData
  273. def toString(): String
    Definition Classes
    AFixNameable → AnyRef → Any
  274. def trim(m: Int): AFix

    Trims the bottom m bits.

    Trims the bottom m bits. Other AFix specific rounding functions are recommended. This function is bit orientated unlike other AFix functions.

    m

    - Number of low bits to trim off

    Definition Classes
    AFixNum
  275. def trim(width: BitCount): AFix
    Definition Classes
    Num
  276. def truncate(): AFix
  277. def truncated: AFix
  278. def truncated(saturation: Boolean, overflow: Boolean, rounding: RoundType): AFix
  279. def unary_-(): AFix
  280. def unary_~: AFix

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    AFixBitwiseOp
  281. def unfreeze(): AFix.this.type
    Definition Classes
    MultiDataData
  282. def unsetName(): AFix.this.type
    Definition Classes
    Nameable
  283. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  284. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  285. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  286. val wholeWidth: Int
  287. def wrapNext(): AFix.this.type
    Definition Classes
    Data
  288. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData
  289. def |(right: AFix): AFix

    Logical OR operator

    Logical OR operator

    Definition Classes
    AFixBitwiseOp
  290. def |<<(shift: Int): AFix
  291. def |<<(shift: AFix): AFix

Deprecated Value Members

  1. def asDirectionLess(): AFix.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  3. def genIf(cond: Boolean): AFix.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

Inherited from MinMaxDecimalProvider

Inherited from BitwiseOp[AFix]

Inherited from Num[AFix]

Inherited from MultiData

Inherited from Data

Inherited from InComponent

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped