Class/Object

FixedPoint

SFix

Related Docs: object SFix | package FixedPoint

Permalink

class SFix extends Fix[SInt, SFix] with Num[SFix]

Annotations
@deprecated
Deprecated

(Since version 3) Use Fixed instead

Source
fixpt.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SFix
  2. Num
  3. Fix
  4. Bundle
  5. Aggregate
  6. Data
  7. Node
  8. Nameable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SFix(exp: Int, raw: SInt)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##[T <: Data](right: T): SFix.this.type

    Permalink

    Interface required by Cat is an operator to combine data nodes together

    Interface required by Cat is an operator to combine data nodes together

    Definition Classes
    Data
  3. def ##(b: Node): Node

    Permalink

    The cat operator to combine two values

    The cat operator to combine two values

    0x5 ## 0x3 => 0x53
    b

    Node to cat after

    returns

    a new node as the combination of both this node and b

    Definition Classes
    Node
  4. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  5. def %(b: SFix): SFix

    Permalink
    Definition Classes
    SFixNum
  6. def *(b: SFix): SFix

    Permalink
    Definition Classes
    SFixNum
  7. def +(b: SFix): SFix

    Permalink
    Definition Classes
    SFixNum
  8. def +(other: Bundle): Bundle

    Permalink

    Create a new Bundle with all the elements of both

    Create a new Bundle with all the elements of both

    Definition Classes
    Bundle
  9. def -(b: SFix): SFix

    Permalink
    Definition Classes
    SFixNum
  10. def /(b: SFix): SFix

    Permalink
    Definition Classes
    SFixNum
  11. def :=(that: Data): Unit

    Permalink
    Definition Classes
    Data
  12. def <(b: SFix): Bool

    Permalink
    Definition Classes
    SFixNum
  13. def <<(b: Int): SFix

    Permalink
  14. def <=(b: SFix): Bool

    Permalink
    Definition Classes
    SFixNum
  15. def <>(src: Node): Unit

    Permalink

    Connect all elements contained in this to node 'src'

    Connect all elements contained in this to node 'src'

    Definition Classes
    BundleNode
    Example:
    1.  // pass through all wires in this modules io to the sub module which have the same name
      // Note: ignores any extra defined in io
      mySubModule.io <> io
    Note

    The elements are checked for compatibility based on their name If elements are in src that are not in this Bundle no warning will be produced

  16. def =/=[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    Data
  17. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def ===[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    Data
  19. def >(b: SFix): Bool

    Permalink
    Definition Classes
    SFixNum
  20. def >=(b: SFix): Bool

    Permalink
    Definition Classes
    SFixNum
  21. def >>(b: Int): SFix

    Permalink
  22. def Factory(exp: Int, width: Int): SFix

    Permalink
    Definition Classes
    SFixFix
  23. def W0Wtransform(): Unit

    Permalink

    Eliminate any zero-width wires attached to this node

    Eliminate any zero-width wires attached to this node

    returns

    if the node was modified

    Definition Classes
    Node
  24. def ^^(src: Node): Unit

    Permalink
    Definition Classes
    Node
  25. val _id: Int

    Permalink

    The unique id of this node

    The unique id of this node

    Definition Classes
    Node
  26. def _isComplementOf(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  27. def aligned_with(b: SFix): (SInt, SInt, Int)

    Permalink
    Definition Classes
    Fix
  28. def apply(name: String): Data

    Permalink
    Definition Classes
    BundleData
  29. def asDirectionless(): SFix.this.type

    Permalink

    set this node as directionless

    set this node as directionless

    Definition Classes
    BundleData
  30. def asInput(): SFix.this.type

    Permalink

    Return this object as an INPUT

    Return this object as an INPUT

    Definition Classes
    BundleData
  31. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  32. def asOutput(): SFix.this.type

    Permalink

    Sets the direction (*dir*) of instances derived from Bits to OUTPUT or recursively sets members of Bundle/Vec to OUTPUT.

    Sets the direction (*dir*) of instances derived from Bits to OUTPUT or recursively sets members of Bundle/Vec to OUTPUT.

    returns

    this instance with its exact type.

    Definition Classes
    BundleData
  33. def assign(src: Node): Unit

    Permalink
    Definition Classes
    Node
  34. def calcElements(view: Seq[String]): LinkedHashMap[String, Data]

    Permalink

    Populates the cache of elements declared in the Bundle.

    Populates the cache of elements declared in the Bundle.

    Attributes
    protected
    Definition Classes
    Bundle
  35. def canCSE: Boolean

    Permalink
    Definition Classes
    Node
  36. def checkPort(obj: Any, name: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Bundle
  37. lazy val chiselName: String

    Permalink
    Definition Classes
    Node
  38. var clock: Option[Clock]

    Permalink

    The clock for this node

    The clock for this node

    Definition Classes
    Node
  39. def clone(): SFix.this.type

    Permalink
    Definition Classes
    Data → AnyRef
  40. def cloneType(): SFix.this.type

    Permalink
    Definition Classes
    Data
  41. def colonEquals(that: Bundle): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    SFixBundleData
  42. def colonEquals[T <: Data](that: Seq[T]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  43. def colonEquals(that: Bits): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  44. var comp: Option[proc]

    Permalink
    Definition Classes
    Data
  45. def componentOf: Module

    Permalink

    Get the module that this node is a part of or the top module if not assigned yet

    Get the module that this node is a part of or the top module if not assigned yet

    returns

    The module that this node is a part of

    Definition Classes
    Node
  46. val consumers: LinkedHashSet[Node]

    Permalink

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes
    Node
  47. def contains(name: String): Boolean

    Permalink

    Check if an element exists with that name

    Check if an element exists with that name

    Definition Classes
    Bundle
  48. def dblLitValue: Double

    Permalink

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  49. def do_addsub(b: SFix, isSub: Boolean = false): SFix

    Permalink
    Definition Classes
    Fix
  50. def do_divide(b: SFix): SFix

    Permalink
    Definition Classes
    Fix
  51. def do_lesseq(b: SFix): Bool

    Permalink
    Definition Classes
    Fix
  52. def do_lessthan(b: SFix): Bool

    Permalink
    Definition Classes
    Fix
  53. def do_mult(b: SFix): SFix

    Permalink
    Definition Classes
    Fix
  54. def do_truncate(source: SFix): Unit

    Permalink
    Definition Classes
    Fix
  55. var driveRand: Boolean

    Permalink
    Definition Classes
    Node
  56. lazy val elements: LinkedHashMap[String, Data]

    Permalink
    Definition Classes
    Bundle
  57. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  58. def equals(that: Any): Boolean

    Permalink

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

    Definition Classes
    Node → AnyRef → Any
  59. def equalsForCSE(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  60. val exp: Int

    Permalink
    Definition Classes
    Fix
  61. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  62. def flatten: Array[(String, Bits)]

    Permalink
    Definition Classes
    BundleData
  63. def flip(): SFix.this.type

    Permalink

    Change all INPUT to OUTPUT and visa versa for all elements in this Bundle

    Change all INPUT to OUTPUT and visa versa for all elements in this Bundle

    Definition Classes
    BundleData
  64. def floLitValue: Float

    Permalink

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  65. def fromBits(b: Bits): SFix.this.type

    Permalink
    Definition Classes
    Data
  66. def fromMap(elemmap: Map[String, Data]): SFix.this.type

    Permalink

    Connect all data nodes in the map as inputs for this bundle using the names in the map

    Connect all data nodes in the map as inputs for this bundle using the names in the map

    Definition Classes
    Bundle
  67. def fromNode(n: Node): SFix.this.type

    Permalink

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Definition Classes
    Data
  68. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  69. def getNode: Node

    Permalink

    returns

    The root node input

    Definition Classes
    Node
  70. def getWidth(): Int

    Permalink

    returns

    the width or number of bits used by this node

    Definition Classes
    BundleAggregateNode
    Exceptions thrown

    ChiselException if the width of the node is unknown

  71. def get_sext(source: Bits): Bool

    Permalink
    Definition Classes
    SFixFix
  72. def hashCode(): Int

    Permalink

    returns

    the unique hashCode for this node

    Definition Classes
    Node → AnyRef → Any
  73. def hashCodeForCSE: Int

    Permalink
    Definition Classes
    Node
  74. def illegalAssignment(that: Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  75. def infer: Boolean

    Permalink

    Called while we're walking the graph inferring the width of nodes.

    Called while we're walking the graph inferring the width of nodes. We return true if we should continue to walk the graph, either because there's a node whose width we don't know, or because we updated a node's width.

    Definition Classes
    Node
  76. def init(n: String, w: Int, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    w

    the bit width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  77. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthFunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  78. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Seq[Node]): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthfunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  79. val inputs: ArrayBuffer[Node]

    Permalink

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  80. def isDirectionless: Boolean

    Permalink

    check if this node is neither INPUT or OUTPUT

    check if this node is neither INPUT or OUTPUT

    Definition Classes
    BundleData
  81. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  82. def isIo: Boolean

    Permalink

    returns

    this node is an I/O Node for a module

    Definition Classes
    Node
  83. def isIo_=(isIo: Boolean): Unit

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    Node
  84. final def isLit: Boolean

    Permalink

    This function determines if a node is a literal, a fixed value

    This function determines if a node is a literal, a fixed value

    Definition Classes
    Node
  85. def isTopLevelIO: Boolean

    Permalink

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  86. var isTypeNode: Boolean

    Permalink
    Definition Classes
    Node
  87. def isTypeOnly: Boolean

    Permalink

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Definition Classes
    BundleDataNode
  88. def isUsedByClockHi: Boolean

    Permalink

    returns

    this node is a Register

    Definition Classes
    Node
  89. def isWired: Boolean

    Permalink
    Definition Classes
    AggregateData
  90. def isZeroWidth: Boolean

    Permalink

    returns

    this node has zero-width

    Definition Classes
    Node
  91. val line: StackTraceElement

    Permalink

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  92. def litOf: Literal

    Permalink

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if there is no literal value available

  93. def litValue(default: BigInt = BigInt(-1)): BigInt

    Permalink

    returns

    the literal value of the node as a BigInt

    Bool(true).litValue() => BigInt(1)
    Definition Classes
    Node
  94. def max(b: SFix): SFix

    Permalink
    Definition Classes
    Num
  95. def maybeFlatten: Seq[Node]

    Permalink

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  96. def min(b: SFix): SFix

    Permalink
    Definition Classes
    Num
  97. var modified: Boolean

    Permalink
    Definition Classes
    Node
  98. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  99. def nameIt(path: String, isNamingIo: Boolean): Unit

    Permalink

    Name the bundle, do not use directly, use setName instead

    Name the bundle, do not use directly, use setName instead

    Definition Classes
    BundleDataNode
  100. var named: Boolean

    Permalink

    named is used to indicate that name was set explicitly and should not be overriden

    named is used to indicate that name was set explicitly and should not be overriden

    Definition Classes
    Nameable
  101. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  102. def needWidth(): Int

    Permalink

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width is not yet defined

  103. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  104. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  105. def params: Parameters

    Permalink
    Definition Classes
    Data
  106. def printTree(writer: PrintStream, depth: Int = 4, indent: String = ""): Unit

    Permalink

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Definition Classes
    Node
  107. var prune: Boolean

    Permalink
    Definition Classes
    Node
  108. val raw: SInt

    Permalink
    Definition Classes
    Fix
  109. def removeTypeNodes(): Unit

    Permalink
    Definition Classes
    BundleNode
  110. def replaceTree(newNode: Node): Unit

    Permalink

    Replace the subtree starting from this node with the indicated replacement

    Replace the subtree starting from this node with the indicated replacement

    newNode

    The node to start tree from

    Definition Classes
    Node
  111. def review(): Unit

    Permalink

    Review a node for optimization possibilities if its children have been updated

    Review a node for optimization possibilities if its children have been updated

    Definition Classes
    Node
  112. def setIsTypeNode: Unit

    Permalink

    make this node a type node

    make this node a type node

    Definition Classes
    BundleData
  113. def setIsWired(value: Boolean): Unit

    Permalink
    Definition Classes
    AggregateData
  114. def setName(n: String): Unit

    Permalink

    Set the name of this module to the string 'n'

    Set the name of this module to the string 'n'

    Definition Classes
    Nameable
    Example:
    1. my.io.node.setName("MY_IO_NODE")
  115. def setWidth(w: Int): Unit

    Permalink

    Force the bit width of a node

    Force the bit width of a node

    w

    the bit width to force

    Definition Classes
    Node
  116. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  117. def toBits(): UInt

    Permalink

    returns

    This node as a UInt

    Definition Classes
    Node
  118. def toBool(): Bool

    Permalink

    Try to convert this data to a Bool

    Try to convert this data to a Bool

    Definition Classes
    Data
    Exceptions thrown

    ChiselException if the width is not 1

  119. lazy val toNode: Node

    Permalink

    returns

    This node

    Definition Classes
    DataNode
  120. def toRaw(a: Bits): SInt

    Permalink
    Definition Classes
    SFixFix
  121. def toString(): String

    Permalink
    Definition Classes
    Bundle → AnyRef → Any
  122. def unary_-(): SFix

    Permalink
    Definition Classes
    SFixNum
  123. def usesInClockHi(i: Node): Boolean

    Permalink
    Definition Classes
    Node
  124. val view: Seq[String]

    Permalink
    Definition Classes
    Bundle
  125. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Num[SFix]

Inherited from Fix[SInt, SFix]

Inherited from Bundle

Inherited from Aggregate

Inherited from Data

Inherited from Node

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped