UInt

Value Members

1. def !=(that: BitPat): Bool

   

   Definition Classes

   Bits

2. def !=(b: Bits): Bool

   

   not equal to

   not equal to

   Definition Classes

   Bits

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

   

   Definition Classes

   AnyRef → Any

4. def ##[T <: Data](right: T): UInt.this.type

   

   Cat bits together to into a single data object with the width of both combined

   Cat bits together to into a single data object with the width of both combined

   Definition Classes

   Bits → Data

5. def ##(b: Node): Node

   

   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

6. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

7. def %(b: SInt): SInt

   

8. def %(b: UInt): UInt

   

   Definition Classes

   UInt → Num

9. def %(b: Bits): Bits

   

   Definition Classes

   Bits

10. def &(b: Bits): UInt.this.type

    

    Bitwise and

    Bitwise and

    Definition Classes

    Bits

11. def *(b: SInt): SInt

    

12. def *(b: UInt): UInt

    

    Definition Classes

    UInt → Num

13. def *(b: Bits): Bits

    

    Definition Classes

    Bits

14. def +(b: SInt): SInt

    

15. def +(b: UInt): UInt

    

    Definition Classes

    UInt → Num

16. def +(b: Bits): Bits

    

    Definition Classes

    Bits

17. def +%(b: UInt): UInt

    

    chisel3 add-wrap operator

18. def +&(b: UInt): UInt

    

    chisel3 add (width +1) operator

19. def -(b: SInt): SInt

    

20. def -(b: UInt): UInt

    

    Definition Classes

    UInt → Num

21. def -(b: Bits): Bits

    

    Definition Classes

    Bits

22. def -%(b: UInt): UInt

    

    chisel3 sub-wrap operator

23. def -&(b: UInt): UInt

    

    chisel3 sub (width +1) operator

24. def /(b: SInt): SInt

    

25. def /(b: UInt): UInt

    

    Definition Classes

    UInt → Num

26. def /(b: Bits): Bits

    

    Definition Classes

    Bits

27. def :=(that: Data): Unit

    

    Definition Classes

    Data

28. def <(b: UInt): Bool

    

    Definition Classes

    UInt → Num

29. def <<(i: Int): UInt

    

30. def <<(b: UInt): UInt.this.type

    

    Shift left operation

    Shift left operation

    Definition Classes

    Bits

31. def <=(b: UInt): Bool

    

    Definition Classes

    UInt → Num

32. def <>(src: Node): Unit

    

    Connect I/O of modules with the same name

    Connect I/O of modules with the same name

    src

    Node to attempt to connect to this instantiation

    Definition Classes

    Bits → Node

33. final def ==(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

34. def ===(b: UInt): Bool

    

35. def ===(that: BitPat): Bool

    

    Definition Classes

    Bits

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

    

    Definition Classes

    Bits → Data

37. def >(b: UInt): Bool

    

    Definition Classes

    UInt → Num

38. def >=(b: UInt): Bool

    

    Definition Classes

    UInt → Num

39. def >>(i: Int): UInt

    

40. def >>(b: UInt): UInt

    

41. def ?(b: UInt): UInt

    

42. def W0Wtransform(): Unit

    

    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

43. def ^(b: Bits): UInt.this.type

    

    Bitwise xor

    Bitwise xor

    Definition Classes

    Bits

44. def ^^(src: Node): Unit

    

    Definition Classes

    Node

45. val _id: Int

    

    The unique id of this node

    The unique id of this node

    Definition Classes

    Node

46. def _isComplementOf(x: Node): Boolean

    

    Definition Classes

    Node

47. def andR(): Bool

    

    reduction and, and all bits together

    reduction and, and all bits together

    Definition Classes

    Bits

48. final def apply(range: (Int, Int)): UInt

    

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    Definition Classes

    Bits

49. final def apply(hi: UInt, lo: UInt): UInt

    

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    Definition Classes

    Bits

50. final def apply(hi: Int, lo: Int): UInt

    

    Extract a range of bits, inclusive from hi to lo

    Extract a range of bits, inclusive from hi to lo

    myBits = 0x5, myBits(1,0) => 0x3

    Definition Classes

    Bits

51. final def apply(bit: UInt): Bool

    

    Extract a single bit at position 'bit' as a Bool

    Extract a single bit at position 'bit' as a Bool

    Definition Classes

    Bits

52. final def apply(bit: Int): Bool

    

    Extract a single Bool at index *bit*.

    Extract a single Bool at index *bit*.

    Definition Classes

    Bits

53. def apply(name: String): Data

    

    Definition Classes

    Bits → Data

54. def asDirectionless(): UInt.this.type

    

    Set this Bits instantiation to be neither of INPUT or OUTPUT

    Set this Bits instantiation to be neither of INPUT or OUTPUT

    Definition Classes

    Bits → Data

55. def asInput(): UInt.this.type

    

    Set this Bits instatiation to be an INPUT

    Set this Bits instatiation to be an INPUT

    Definition Classes

    Bits → Data

56. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

57. def asOutput(): UInt.this.type

    

    Set this Bits instatiation to be an OUTPUT

    Set this Bits instatiation to be an OUTPUT

    returns

    this instance with its exact type.

    Definition Classes

    Bits → Data

58. final def asTypeFor(node: Node): UInt.this.type

    

    assigns this instance as the data type for *node*.

    assigns this instance as the data type for *node*.

    Attributes

    protected[Chisel]

    Definition Classes

    Bits

59. def assign(src: Node): Unit

    

    Definition Classes

    Bits → Node

60. def bitSet(off: UInt, dat: UInt): UInt.this.type

    

    Set bit 'off' in data dat

    Set bit 'off' in data dat

    off

    which bit to set

    dat

    A UInt in which to set the bit

    Definition Classes

    Bits

61. def canCSE: Boolean

    

    Definition Classes

    Node

62. lazy val chiselName: String

    

    Definition Classes

    Node

63. var clock: Option[Clock]

    

    The clock for this node

    The clock for this node

    Definition Classes

    Node

64. def clone(): UInt.this.type

    

    Definition Classes

    Data → AnyRef

65. def cloneType(): UInt.this.type

    

    Copy this instantiation of the Chisel Data type with all parameters such as width and I/O direction the same

    Copy this instantiation of the Chisel Data type with all parameters such as width and I/O direction the same

    Definition Classes

    Bits → Data

66. def colonEquals(that: Bits): Unit

    

    Assignment operator

    Assignment operator

    Attributes

    protected

    Definition Classes

    Bits → Data

67. def colonEquals[T <: Data](that: Iterable[T]): Unit

    

    Attributes

    protected

    Definition Classes

    Data

68. def colonEquals(that: Bundle): Unit

    

    Attributes

    protected

    Definition Classes

    Data

69. var comp: Option[proc]

    

    Definition Classes

    Data

70. def componentOf: Module

    

    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

71. val consumers: LinkedHashSet[Node]

    

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes

    Node

72. def create(dir: IODirection, width: Int): Unit

    

    Definition Classes

    Bits

73. def dblLitValue: Double

    

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes

    Node

74. def default: proc

    

    Attributes

    protected

    Definition Classes

    proc

75. def defaultMissing: Boolean

    

    Attributes

    protected

    Definition Classes

    proc

76. def defaultRequired: Boolean

    

    Definition Classes

    Bits → proc

77. var dir: IODirection

    

    Definition Classes

    Bits

78. def doProcAssign(src: Node, cond: Bool): Unit

    

    Attributes

    protected[Chisel]

    Definition Classes

    proc

79. var driveRand: Boolean

    

    Definition Classes

    Node

80. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

81. def equals(that: Any): Boolean

    

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

    Definition Classes

    Node → AnyRef → Any

82. def equalsForCSE(x: Node): Boolean

    

    Definition Classes

    Node

83. def error(b: Bits): Bits

    

    Error shown when operation is not defined

    Error shown when operation is not defined

    Definition Classes

    Bits

    Exceptions thrown

    ChiselException if the operation is not defined

84. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

85. def flatten: Array[(String, Bits)]

    

    Definition Classes

    Bits → Data

86. def flip(): UInt.this.type

    

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Change INPUT to OUTPUT and OUTPUT to INPUT

    Definition Classes

    Bits → Data

87. def floLitValue: Float

    

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes

    Node

88. def forceMatchingWidths: Unit

    

    Force the width of this nodes input to have the same width this if known if input node width is known force width of this node

    Force the width of this nodes input to have the same width this if known if input node width is known force width of this node

    Definition Classes

    Bits → Node

89. def fromBits(b: Bits): UInt.this.type

    

    Definition Classes

    Data

90. def fromInt(x: Int): UInt.this.type

    

    Set the value of this UInt

    Set the value of this UInt

    Definition Classes

    UInt → Bits

91. def fromNode(n: Node): UInt.this.type

    

    Factory method to create and assign a *UInt* type to a Node *n*.

    Factory method to create and assign a *UInt* type to a Node *n*.

    Definition Classes

    UInt → Data

92. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

93. def getNode: Node

    
    returns

    The root node input

    Definition Classes

    Bits → Node

94. def getWidth(): Int

    
    returns

    the width or number of bits used by this node

    Definition Classes

    Node

    Exceptions thrown

    ChiselException if the width of the node is unknown

95. def hashCode(): Int

    
    returns

    the unique hashCode for this node

    Definition Classes

    Node → AnyRef → Any

96. def hashCodeForCSE: Int

    

    Definition Classes

    Node

97. def illegalAssignment(that: Any): Unit

    

    Attributes

    protected

    Definition Classes

    Data

98. def infer: Boolean

    

    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

99. def init(n: String, w: Int, ins: Node*): Node

    

    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

100. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

     

     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

101. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Iterable[Node]): Node

     

     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

102. val inputs: ArrayBuffer[Node]

     

     The inputs that this node depends on

     The inputs that this node depends on

     Definition Classes

     Node

103. def isDirectionless: Boolean

     
     returns

     this instantiation is neither of INPUT or OUTPUT

     Definition Classes

     Bits → Data

104. final def isInstanceOf[T0]: Boolean

     

     Definition Classes

     Any

105. def isIo: Boolean

     
     returns

     this node is an I/O Node for a module

     Definition Classes

     Node

106. def isIo_=(isIo: Boolean): Unit

     

     Definition Classes

     Node

107. final def isLit: Boolean

     

     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

108. def isReg: Boolean

     
     returns

     this node is a Register

     Definition Classes

     Node

109. def isTopLevelIO: Boolean

     
     returns

     is this node I/O for the top level module

     Definition Classes

     Node

110. var isTypeNode: Boolean

     

     Definition Classes

     Node

111. def isTypeOnly: Boolean

     

     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

     Data → Node

112. def isUsedByClockHi: Boolean

     

     Definition Classes

     Node

113. def isWired: Boolean

     

     Definition Classes

     Data

114. def isZeroWidth: Boolean

     
     returns

     this node has zero-width

     Definition Classes

     Node

115. val line: StackTraceElement

     

     The trace information for chisel for this node

     The trace information for chisel for this node

     Definition Classes

     Node

116. def litOf: Literal

     
     returns

     the literal value of a node

     Definition Classes

     Node

     Exceptions thrown

     ChiselException if there is no literal value available

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

     
     returns

     the literal value of the node as a BigInt

     Bool(true).litValue() => BigInt(1)

     Definition Classes

     Node

118. def matchWidth(w: Width): Node

     

     Definition Classes

     Bits → Node

119. def max(b: UInt): UInt

     

     Definition Classes

     Num

120. def maybeFlatten: Seq[Node]

     

     Deprecated: Do not use

     Deprecated: Do not use

     Definition Classes

     Node

121. def min(b: UInt): UInt

     

     Definition Classes

     Num

122. var modified: Boolean

     

     Definition Classes

     Node

123. def muxes: Seq[Mux]

     

     Attributes

     protected[Chisel]

     Definition Classes

     proc

124. var name: String

     

     Name of the instance.

     Name of the instance.

     Definition Classes

     Nameable

125. def nameIt(path: String, isNamingIo: Boolean): Unit

     

     name this node

     name this node

     Definition Classes

     Data → Node

     Note

     use setName in Node rather than this directly

126. var named: Boolean

     

     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

127. final def ne(arg0: AnyRef): Boolean

     

     Definition Classes

     AnyRef

128. def needWidth(): Int

     
     returns

     the bitWidth of the node

     Definition Classes

     Node

     Exceptions thrown

     ChiselException if the width is not yet defined

129. final def newBinaryOp(right: Bits, opName: String): UInt.this.type

     

     Attributes

     protected

     Definition Classes

     Bits

130. final def newLogicalOp(right: Bits, opName: String): Bool

     

     Attributes

     protected

     Definition Classes

     Bits

131. final def newReductionOp(opName: String): Bool

     

     Attributes

     protected

     Definition Classes

     Bits

132. final def newUnaryOp(opName: String): UInt.this.type

     

     Attributes

     protected

     Definition Classes

     Bits

133. def next: Node

     

     Attributes

     protected[Chisel]

     Definition Classes

     proc

134. def nextOpt: Option[Node]

     

     Attributes

     protected[Chisel]

     Definition Classes

     proc

135. final def notify(): Unit

     

     Definition Classes

     AnyRef

136. final def notifyAll(): Unit

     

     Definition Classes

     AnyRef

137. def orR(): Bool

     

     reduction or, or all bits together

     reduction or, or all bits together

     Definition Classes

     Bits

138. def params: Parameters

     

     Definition Classes

     Data

139. def printTree(writer: PrintStream, depth: Int = 4, indent: String = ""): Unit

     

     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

140. def procAssign(src: Node): Unit

     

     Definition Classes

     Bits → proc

141. var procAssigned: Boolean

     

     Attributes

     protected

     Definition Classes

     proc

142. var prune: Boolean

     

     Definition Classes

     Node

143. def replaceTree(newNode: Node): Unit

     

     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

144. def review(): Unit

     

     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

145. def setDefault(src: Node): Unit

     

     Attributes

     protected

     Definition Classes

     proc

146. def setIsTypeNode: Unit

     

     make this node a type node

     make this node a type node

     Definition Classes

     Data

147. def setIsWired(value: Boolean): Unit

     

     Definition Classes

     Data

148. def setName(n: String): Unit

     

     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")

149. def setWidth(w: Int): Unit

     

     Force the bit width of a node

     Force the bit width of a node

     w

     the bit width to force

     Definition Classes

     Node

150. final def synchronized[T0](arg0: ⇒ T0): T0

     

     Definition Classes

     AnyRef

151. def toBits(): UInt

     
     returns

     This node as a UInt

     Definition Classes

     UInt → Node

152. def toBool(): Bool

     

     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

153. def toBools: Vec[Bool]

     

     Split up this bits instantiation to a Vec of Bools

     Split up this bits instantiation to a Vec of Bools

     Definition Classes

     Bits

154. lazy val toNode: Node

     
     returns

     This node

     Definition Classes

     Data → Node

155. def toSInt(): SInt

     

     Definition Classes

     Bits

156. def toString(): String

     

     Definition Classes

     Bits → AnyRef → Any

157. def toUInt(): UInt

     

     Definition Classes

     Bits

158. def unary_!(): Bool

     

159. def unary_-(): UInt

     

     Definition Classes

     UInt → Num

160. def unary_~(): UInt.this.type

     

     invert all bits with ~

     invert all bits with ~

     Definition Classes

     Bits

161. def usesInClockHi(i: Node): Boolean

     

     Definition Classes

     Node

162. def verifyMuxes: Unit

     

     Attributes

     protected[Chisel]

     Definition Classes

     proc

163. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

164. final def wait(arg0: Long, arg1: Int): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

165. final def wait(arg0: Long): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

166. def xorR(): Bool

     

     reduction xor, xor all bits together

     reduction xor, xor all bits together

     Definition Classes

     Bits

167. def zext(): SInt

     

     Convert a UInt to an SInt by added a MSB zero

168. def |(b: Bits): UInt.this.type

     

     Bitwise or

     Bitwise or

     Definition Classes

     Bits