Utils

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

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

   

   Definition Classes

   AnyRef → Any

4. val BoolType: UIntType

   

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def ceilLog2(x: BigInt): Int

   

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def create_exps(e: Expression): Seq[Expression]

   

9. def create_exps(n: String, t: Type): Seq[Expression]

   

10. def diff(e1: Expression, e2: Expression): Seq[(Expression, Expression)]

    

    Walks two expression trees and returns a sequence of tuples of where they differ

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

    

    Definition Classes

    AnyRef

12. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

13. def error(str: String, cause: Throwable = null): Nothing

    

14. def expandPrefixes(name: String, prefixDelim: String = "_"): Seq[String]

    

    Expand a name into its prefixes, e.g., 'foo_barbaz' becomes 'Seq[foo_, foo_bar, foo_barbaz]'. This can be used to produce better names when generating prefix unique names.

    Expand a name into its prefixes, e.g., 'foo_barbaz' becomes 'Seq[foo_, foo_bar, foo_barbaz]'. This can be used to produce better names when generating prefix unique names.

    name

    a signal name

    prefixDelim

    a prefix delimiter (default is "_")

    returns

    the signal name and any prefixes

15. def field_flip(v: Type, s: String): Orientation

    

16. def field_type(v: Type, s: String): Type

    

17. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

18. def gender(e: Expression): Gender

    

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

    

    Definition Classes

    AnyRef → Any

20. def getDeclaration(m: Module, expr: Expression): IsDeclaration

    

    Gets the root declaration of an expression

    Gets the root declaration of an expression

    m

    the firrtl.ir.Module to search

    expr

    the firrtl.ir.Expression that refers to some declaration

    returns

    the firrtl.ir.IsDeclaration of expr

    Exceptions thrown

    DeclarationNotFoundException if no declaration of expr is found

21. def getKids(e: Expression): Seq[Expression]

    

    Returns children Expressions of e

22. def getThrowable(maybeException: Option[Throwable], first: Boolean): Throwable

    

    Unwind the causal chain until we hit the initial exception (which may be the first).

    Unwind the causal chain until we hit the initial exception (which may be the first).

    maybeException

    - possible exception triggering the error,

    first

    - true if we want the first (eldest) exception in the chain,

    returns

    first or last Throwable in the chain.

23. def get_field(v: Type, s: String): Field

    

24. def get_flip(t: Type, i: Int, f: Orientation): Orientation

    

25. def get_gender(p: Port): Gender

    

26. def get_gender(s: Statement): Gender

    

27. def get_info(s: Statement): Info

    

28. def get_point(e: Expression): Int

    

29. def get_size(t: Type): Int

    

30. def get_valid_points(t1: Type, t2: Type, flip1: Orientation, flip2: Orientation): Seq[(Int, Int)]

    

31. def hasFlip(t: Type): Boolean

    

    Returns true if t, or any subtype, contains a flipped field

    Returns true if t, or any subtype, contains a flipped field

    t

    type firrtl.ir.Type to be checked

    returns

    if t contains firrtl.ir.Flip

32. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

33. def indent(str: String): String

    

    Indent the results of ir.FirrtlNode.serialize

34. def inline(nodeMap: NodeMap, stop: (String) ⇒ Boolean = x: String => false)(e: Expression): Expression

    

    Returns an inlined expression (replacing node references with values), stopping on a stopping condition or until the reference is not a node

35. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

36. def isTemp(str: String): Boolean

    

37. def kind(e: Expression): Kind

    

38. val logger: Logger

    

    Definition Classes

    LazyLogging

39. def max(a: BigInt, b: BigInt): BigInt

    

40. def mergeRef(root: Expression, body: Expression): Expression

    

    Adds a root reference to some SubField/SubIndex chain

41. def min(a: BigInt, b: BigInt): BigInt

    

42. def module_type(m: DefModule): Type

    

43. def mux_type(t1: Type, t2: Type): Type

    

44. def mux_type(e1: Expression, e2: Expression): Type

    

45. def mux_type_and_widths(t1: Type, t2: Type): Type

    

46. def mux_type_and_widths(e1: Expression, e2: Expression): Type

    

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

    

    Definition Classes

    AnyRef

48. def niceName(depth: Int)(e: Expression): String

    

49. def niceName(e: Expression): String

    

    Provide a nice name to create a temporary *

50. final def notify(): Unit

    

    Definition Classes

    AnyRef

51. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

52. val one: UIntLiteral

    

53. def pow_minus_one(a: BigInt, b: BigInt): BigInt

    

54. def splitRef(e: Expression): (WRef, Expression)

    

    Splits an Expression into root Ref and tail

    Splits an Expression into root Ref and tail

    Examples:

    1. Given: SubField(SubIndex(Ref("b"), 2), "c") Returns: (Ref("b"), SubField(SubIndex(EmptyExpression, 2), "c")) b[2].c -> (b, EMPTY[2].c)

    ,

    2. Given: SubField(SubIndex(SubField(Ref("a", UIntType(IntWidth(32))), "b"), 2), "c") Returns: (Ref("a"), SubField(SubIndex(Ref("b"), 2), "c")) a.b[2].c -> (a, b[2].c)

    Note

    This function only supports WRef, WSubField, and WSubIndex

55. def squashEmpty(s: Statement): Statement

    

    Removes all firrtl.ir.EmptyStmt statements and condenses firrtl.ir.Block statements.

56. def sub_type(v: Type): Type

    

57. def swap(f: Orientation): Orientation

    

58. def swap(d: Direction): Direction

    

59. def swap(g: Gender): Gender

    

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

    

    Definition Classes

    AnyRef

61. def throwInternalError(message: String = "", exception: Option[Exception] = None): Nothing

    

    Throw an internal error, possibly due to an exception.

    Throw an internal error, possibly due to an exception.

    message

    - possible string to emit,

    exception

    - possible exception triggering the error.

62. def times(f1: Orientation, f2: Orientation): Orientation

    

63. def times(flip: Orientation, g: Gender): Gender

    

64. def times(g: Gender, flip: Orientation): Gender

    

65. def times(d: Direction, g: Gender): Direction

    

66. def times(g: Gender, d: Direction): Direction

    

67. def times(d: Direction, flip: Orientation): Direction

    

68. def toString(): String

    

    Definition Classes

    AnyRef → Any

69. implicit def toWrappedExpression(x: Expression): WrappedExpression

    

70. def to_dir(g: Gender): Direction

    

71. def to_flip(g: Gender): Orientation

    

72. def to_flip(d: Direction): Orientation

    

73. def to_gender(d: Direction): Gender

    

74. val v_keywords: Set[String]

    

75. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

78. val zero: UIntLiteral