Class

cogx.compiler.parser.syntaxtree

UnpipelinedVectorActuator

Related Doc: package syntaxtree

Permalink

class UnpipelinedVectorActuator extends Operation with SemanticError with RestoreHooks

An output from a Cog computation, called an actuator.

An output scalar field value is generated on every cycle of the simulation. The user function newOutput is called when the output is ready, so that the user may use that information elsewhere.

Linear Supertypes
RestoreHooks, SemanticError, CompilerError, Operation, Hypernode[Operation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UnpipelinedVectorActuator
  2. RestoreHooks
  3. SemanticError
  4. CompilerError
  5. Operation
  6. Hypernode
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnpipelinedVectorActuator(source: Field, update: (Iterator[Float]) ⇒ Unit, resetHook: () ⇒ Unit)

    Permalink

    Create an actuator for a nD scalar field source that invokes a callback function 'newOutput' that is passed an Iterator[Vector].

    Create an actuator for a nD scalar field source that invokes a callback function 'newOutput' that is passed an Iterator[Vector].

    This preserves the legacy constructor "new Actuator(source, update)"

    source

    The field to written output to an array each clock cycle.

    update

    A callback that is passed an iterator over the new values.

    resetHook

    An optional callback function that is called upon reset.

    returns

    An actuator that writes source to output each cycle.

  2. new UnpipelinedVectorActuator(source: Field, update: (Iterator[Float]) ⇒ Unit)

    Permalink

    Create an actuator for a nD scalar field source that invokes a callback function 'newOutput' that is passed an Iterator[Vector].

    Create an actuator for a nD scalar field source that invokes a callback function 'newOutput' that is passed an Iterator[Vector].

    This preserves the legacy constructor "new Actuator(source, update)"

    source

    The field to written output to an array each clock cycle.

    update

    A callback that is passed an iterator over the new values.

    returns

    An actuator that writes source to output each cycle.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addOutput(edge: Hyperedge[Operation]): Unit

    Permalink

    Add sink node to this hyperedge.

    Add sink node to this hyperedge.

    Definition Classes
    Hypernode
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val circuit: Hypercircuit[Operation]

    Permalink

    Circuit that this Node belongs to.

    Circuit that this Node belongs to. If the node has no inputs, it must get the owning circuit from the Circuit object (which, as has been noted above, is not thread safe). If it has inputs, it gets the owning circuit from the first input.

    Definition Classes
    Hypernode
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def inputs: Seq[Field]

    Permalink

    The inputs to this kernel, as Fields, not as the base class Hyperedge[Operation]

    The inputs to this kernel, as Fields, not as the base class Hyperedge[Operation]

    Definition Classes
    Operation → Hypernode
  14. def internalError(message: String): Unit

    Permalink

    Declare an internal error described by message.

    Declare an internal error described by message.

    Definition Classes
    CompilerError
  15. def isDead: Boolean

    Permalink

    Check if node is dead (removed from circuit).

    Check if node is dead (removed from circuit).

    Definition Classes
    Hypernode
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  20. def numInputs: Int

    Permalink

    Get the number of input hyperedges driving this hypernode.

    Get the number of input hyperedges driving this hypernode.

    Definition Classes
    Hypernode
  21. def numOutputs: Int

    Permalink

    Get the number of output hyperedges driven by this hypernode.

    Get the number of output hyperedges driven by this hypernode.

    Definition Classes
    Hypernode
  22. val opcode: Opcode

    Permalink
    Definition Classes
    Operation
  23. def outputIndex(edge: Hyperedge[Operation]): Option[Int]

    Permalink

    Get the output index of a hyperedge on the source.

    Get the output index of a hyperedge on the source.

    Definition Classes
    Hypernode
  24. def outputs: Seq[Field]

    Permalink

    The outputs to this kernel, as Fields, not as the base class Hyperedge[Operation]

    The outputs to this kernel, as Fields, not as the base class Hyperedge[Operation]

    Definition Classes
    Operation → Hypernode
  25. def removeFromCircuit(mustDo: Boolean, recursive: Boolean = true): Unit

    Permalink

    Remove node from circuit, recursively removing input nodes that are no longer used because the removal of node removed the last sink on all outputs.

    Remove node from circuit, recursively removing input nodes that are no longer used because the removal of node removed the last sink on all outputs.

    mustDo

    Throw an exception if the node is output-connected

    recursive

    After removing this, recursively remove the inputs if possible

    Definition Classes
    Hypernode
  26. def replaceInput(i: Int, edge: Hyperedge[Operation]): Unit

    Permalink

    Get the inputs consumed by this node.

    Get the inputs consumed by this node.

    Definition Classes
    Hypernode
  27. def restoreParameters: String

    Permalink

    A hook that should be overridden by users to supply the info needed to reconstruct the sensor or actuator.

    A hook that should be overridden by users to supply the info needed to reconstruct the sensor or actuator.

    Definition Classes
    RestoreHooks
  28. def restoringClass: AnyRef

    Permalink

    A hook that should be overridden by users if necessary to point to a class with a restore method.

    A hook that should be overridden by users if necessary to point to a class with a restore method.

    Definition Classes
    RestoreHooks
  29. def stealOutputsFrom(from: Operation): Unit

    Permalink

    Steal all sinks from another node, from, and add them to this.

    Steal all sinks from another node, from, and add them to this.

    This makes the from useless since whatever signal it drives is not used by any other node. Consequently from is removed from the circuit.

    from

    The node from which to steal outputs; this node will then be removed from the circuit after the theft is complete.

    Definition Classes
    Hypernode
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink

    A description of the operation and the FieldTypes it operates on

    A description of the operation and the FieldTypes it operates on

    Definition Classes
    Operation → Hypernode → AnyRef → Any
  32. final def wait(): Unit

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

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

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

Inherited from RestoreHooks

Inherited from SemanticError

Inherited from CompilerError

Inherited from Operation

Inherited from Hypernode[Operation]

Inherited from AnyRef

Inherited from Any

Ungrouped