Operator

A user-defined operator, allowing the user to write Cog code that can't be easily parallelized and must be executed on the CPU.

To define an Operator, create an object which extends this class and define a 'compute' method in it. Here's an example:

/** An operator which flips a picture upside down. */
object upsideDown extends Operator {
  def compute(in: ScalarFieldReader, out: ScalarFieldWriter) {
    out.setShape(in.fieldShape)
    for (row <- 0 until in.rows; col <- 0 until in.columns) {
      val pixel = in.read(row, col)
      result.write(in.rows - row - 1, col, pixel)
    }
  }
}

To invoke this operator, use it like a function:

val graph = new ComputeGraph {
   val field = ScalarField(...)
   val flipped = upsideDown(field)
}

This class does the necessary reflective magic to connect up the compute method, which is written using *FieldReader and *FieldWriter objects, to Fields.

Linear Supertypes

SemanticError, CompilerError, AnyRef, Any

Instance Constructors

new Operator()

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val Verbose: Boolean

Debugging flag.
def apply(inputs: parser.syntaxtree.Field*): parser.syntaxtree.Field

Create an instance of the operator.
Create an instance of the operator.
inputs
Fields that are inputs to the operator.
returns
Field resulting from execution of the operator.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def internalError(message: String): Unit

Declare an internal error described by message.
Declare an internal error described by message.

Definition Classes
CompilerError
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String

User-defined name of the operator.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package cpu_operator

abstract class Operator extends SemanticError

Instance Constructors

new Operator()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val Verbose: Boolean

def apply(inputs: parser.syntaxtree.Field*): parser.syntaxtree.Field

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def internalError(message: String): Unit

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from SemanticError

Inherited from CompilerError

Inherited from AnyRef

Inherited from Any

Ungrouped