org.apache.sysml.udf

Class PackageFunction

java.lang.Object

org.apache.sysml.udf.PackageFunction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BinningWrapper, CumSumProd, DynamicProjectMatrixCP, DynamicReadMatrixCP, DynamicReadMatrixRcCP, DynamicWriteMatrixCP, EvalFunction, GatherWrapper, MultiInputCbind, OrderWrapper, RemoveEmptyRows, RowClassMeet, SGDNesterovUpdate, TimeWrapper

public abstract class PackageFunction
extends Object
implements Serializable

Abstract class that should be extended to implement a package function.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PackageFunction()

Method Summary

Modifier and Type	Method and Description
String	createOutputFilePathAndName(String fname)
abstract void	execute() Method that will be executed to perform this function.
void	execute(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec) Method that will be executed to perform this function.
String	getBaseDir()
String	getConfiguration() Method to get the configuration file name
FunctionParameter	getFunctionInput(int pos) Method to get a specific input to this package function.
abstract FunctionParameter	getFunctionOutput(int pos) Method to get a specific output of this package function.
int	getNumFunctionInputs() Method to get the number of inputs to this package function.
abstract int	getNumFunctionOutputs() Method to get the number of outputs of this package function.
boolean	hasVarNumFunctionOutputs() Indicates if the function has a variable number of outputs, that is unknown until the function has been executed.
void	setBaseDir(String dir)
void	setConfiguration(String fName) Method to set the configuration file for this function.
void	setFunctionInputs(ArrayList<FunctionParameter> inputs)
void	setInput(FunctionParameter input, int pos) Method to set a specific input for this package function
void	setNumFunctionInputs(int numInputs) Method to set the number of inputs for this package function

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PackageFunction

public PackageFunction()

Method Detail

getNumFunctionInputs

public final int getNumFunctionInputs()

Method to get the number of inputs to this package function.

Returns:

number of inputs

getFunctionInput

public final FunctionParameter getFunctionInput(int pos)

Method to get a specific input to this package function.

Parameters:

pos - input position

Returns:

function parameter

getNumFunctionOutputs

public abstract int getNumFunctionOutputs()

Method to get the number of outputs of this package function. This method should be implemented in the user's function.

Returns:

number of outputs

hasVarNumFunctionOutputs

public boolean hasVarNumFunctionOutputs()

Indicates if the function has a variable number of outputs, that is unknown until the function has been executed.

Returns:

true if the number of outputs is unknown; otherwise false.

getFunctionOutput

public abstract FunctionParameter getFunctionOutput(int pos)

Method to get a specific output of this package function. This method should be implemented in the user's function.

Parameters:

pos - function position

Returns:

function parameter

setFunctionInputs

public final void setFunctionInputs(ArrayList<FunctionParameter> inputs)

setNumFunctionInputs

public final void setNumFunctionInputs(int numInputs)

Method to set the number of inputs for this package function

Parameters:

numInputs - number of inputs

setInput

public final void setInput(FunctionParameter input,
                           int pos)

Method to set a specific input for this package function

Parameters:

input - function parameter input

pos - input position

setConfiguration

public final void setConfiguration(String fName)

Method to set the configuration file for this function.

Parameters:

fName - configuration file name

getConfiguration

public final String getConfiguration()

Method to get the configuration file name

Returns:

configuration file name

setBaseDir

public void setBaseDir(String dir)

getBaseDir

public String getBaseDir()

createOutputFilePathAndName

public String createOutputFilePathAndName(String fname)

execute

public abstract void execute()

Method that will be executed to perform this function.

execute

public void execute(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec)

Method that will be executed to perform this function. The default implementation simply forwards this call to execute.

Parameters:

ec - execution context with access to the program e.g., for access to other dml-bodied or external functions.