Value Members

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

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  def +(other: String): String

   Implicit

   This member is added by an implicit conversion from CompositeModule to any2stringadd[CompositeModule] performed by method any2stringadd in scala.Predef.

   Definition Classes

   any2stringadd

4.  def ->[B](y: B): (CompositeModule, B)

   Implicit

   This member is added by an implicit conversion from CompositeModule to ArrowAssoc[CompositeModule] performed by method ArrowAssoc in scala.Predef.

   Definition Classes

   ArrowAssoc

   Annotations

   @inline()

5.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

6.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7.  val attributes: Attributes

   Definition Classes

   CompositeModule → Module

8.  def carbonCopy: Module

   The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided.

   The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided. Where a full copy is not possible or desirable, use a CopiedModule. The shape of the resulting module MUST NOT contain the same ports as this module’s shape.

   Definition Classes

   CompositeModule → Module

9.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

10.  def compose[A, B, C](that: Module, f: (A, B) ⇒ C): Module

    Creates a new Module which is this Module composed with that Module, using the given function f to compose the materialized value of this with the materialized value of that.

    Creates a new Module which is this Module composed with that Module, using the given function f to compose the materialized value of this with the materialized value of that.

    A

    the type of the materialized value of this

    B

    the type of the materialized value of that

    C

    the type of the materialized value of the returned Module

    that

    a Module to be composed with (cannot be itself)

    f

    a function which combines the materialized values

    returns

    a Module that represents the composition of this and that

    Definition Classes

    Module

11.  def compose(that: Module): Module

    Creates a new Module which is this Module composed with that Module.

    Creates a new Module which is this Module composed with that Module.

    that

    a Module to be composed with (cannot be itself)

    returns

    a Module that represents the composition of this and that

    Definition Classes

    Module

12.  def composeNoMat(that: Module): Module

    Creates a new Module which is this Module composed with that Module.

    Creates a new Module which is this Module composed with that Module.

    The difference to compose(that) is that this version completely ignores the materialized value computation of that while the normal version executes the computation and discards its result. This means that this version must not be used for user-provided that modules because users may transform materialized values only to achieve some side-effect; it can only be used where we know that there is no meaningful computation to be done (like for MaterializedValueSource).

    that

    a Module to be composed with (cannot be itself)

    returns

    a Module that represents the composition of this and that

    Definition Classes

    Module

13.  val downstreams: Map[OutPort, InPort]

    Definition Classes

    CompositeModule → Module

14.  def ensuring(cond: (CompositeModule) ⇒ Boolean, msg: ⇒ Any): CompositeModule

    Implicit

    This member is added by an implicit conversion from CompositeModule to Ensuring[CompositeModule] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

15.  def ensuring(cond: (CompositeModule) ⇒ Boolean): CompositeModule

    Implicit

    This member is added by an implicit conversion from CompositeModule to Ensuring[CompositeModule] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

16.  def ensuring(cond: Boolean, msg: ⇒ Any): CompositeModule

    Implicit

    This member is added by an implicit conversion from CompositeModule to Ensuring[CompositeModule] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

17.  def ensuring(cond: Boolean): CompositeModule

    Implicit

    This member is added by an implicit conversion from CompositeModule to Ensuring[CompositeModule] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

18.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

19.  final def equals(obj: Any): Boolean

    Definition Classes

    Module → AnyRef → Any

20.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

21.  def formatted(fmtstr: String): String

    Implicit

    This member is added by an implicit conversion from CompositeModule to StringFormat[CompositeModule] performed by method StringFormat in scala.Predef.

    Definition Classes

    StringFormat

    Annotations

    @inline()

22.  final def fuse[A, B, C](that: Module, from: OutPort, to: InPort, f: (A, B) ⇒ C): Module

    Fuses this Module to that Module by wiring together from and to, transforming the materialized values of this and that using the provided function f

    Fuses this Module to that Module by wiring together from and to, transforming the materialized values of this and that using the provided function f

    that

    a Module to fuse with

    from

    the data source to wire

    to

    the data sink to wire

    f

    the function to apply to the materialized values

    returns

    a Module representing the fusion of this and that

    Definition Classes

    Module

23.  final def fuse(that: Module, from: OutPort, to: InPort): Module

    Fuses this Module to that Module by wiring together from and to, retaining the materialized value of this in the result

    Fuses this Module to that Module by wiring together from and to, retaining the materialized value of this in the result

    that

    a Module to fuse with

    from

    the data source to wire

    to

    the data sink to wire

    returns

    a Module representing the fusion of this and that

    Definition Classes

    Module

24.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

25.  final def hashCode(): Int

    Definition Classes

    Module → AnyRef → Any

26.  final lazy val inPorts: Set[InPort]

    Definition Classes

    Module

27.  def isAtomic: Boolean

    Definition Classes

    Module

28.  final def isBidiFlow: Boolean

    Definition Classes

    Module

29.  def isCopied: Boolean

    Definition Classes

    Module

30.  final def isFlow: Boolean

    Definition Classes

    Module

31.  def isFused: Boolean

    Definition Classes

    Module

32.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

33.  def isRunnable: Boolean

    Definition Classes

    Module

34.  final def isSealed: Boolean

    Definition Classes

    Module

35.  final def isSink: Boolean

    Definition Classes

    Module

36.  final def isSource: Boolean

    Definition Classes

    Module

37.  val materializedValueComputation: MaterializedValueNode

    Definition Classes

    CompositeModule → Module

38.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

39.  final def notify(): Unit

    Definition Classes

    AnyRef

40.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

41.  final lazy val outPorts: Set[OutPort]

    Definition Classes

    Module

42.  def replaceShape(s: Shape): Module

    Verify that the given Shape has the same ports and return a new module with that shape.

    Verify that the given Shape has the same ports and return a new module with that shape. Concrete implementations may throw UnsupportedOperationException where applicable.

    Please note that this method MUST NOT be implemented using a CopiedModule since the purpose of replaceShape can also be to rearrange the ports (as in BidiFlow.reversed) and that purpose would be defeated.

    Definition Classes

    CompositeModule → Module

43.  val shape: Shape

    Definition Classes

    CompositeModule → Module

44.  val subModules: Set[Module]

    Definition Classes

    CompositeModule → Module

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

    Definition Classes

    AnyRef

46.  def toString(): String

    Definition Classes

    CompositeModule → AnyRef → Any

47.  final def transformMaterializedValue(f: (Any) ⇒ Any): Module

    Definition Classes

    Module

48.  val upstreams: Map[InPort, OutPort]

    Definition Classes

    CompositeModule → Module

49.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

51.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

52.  final def wire(from: OutPort, to: InPort): Module

    Creates a new Module based on the current Module but with the given OutPort wired to the given InPort.

    Creates a new Module based on the current Module but with the given OutPort wired to the given InPort.

    from

    the OutPort to wire

    to

    the InPort to wire

    returns

    a new Module with the ports wired

    Definition Classes

    Module

53.  def withAttributes(attributes: Attributes): Module

    Definition Classes

    CompositeModule → Module

54.  def →[B](y: B): (CompositeModule, B)

    Implicit

    This member is added by an implicit conversion from CompositeModule to ArrowAssoc[CompositeModule] performed by method ArrowAssoc in scala.Predef.

    Definition Classes

    ArrowAssoc