Package com.singularsys.extensions.chained

Class ChainableBinaryFunction

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.misc.overloadedfunctions.AlternateFunctions

com.singularsys.extensions.chained.ChainableBinaryFunction

All Implemented Interfaces:

ChainedFunctionI, DirtyFunction, CallbackEvaluationI, JepComponent, PostfixMathCommandI, Serializable

public class ChainableBinaryFunction
extends AlternateFunctions
implements ChainedFunctionI, DirtyFunction

Converts a BinaryFunction so it can be used in a chain or directly as binary function. If the number of arguments is 1, then the a ChainedBinaryFunction is used, otherwise the function is used normally.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.singularsys.jep.misc.overloadedfunctions.AlternateFunctions

functions, nf, ot

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
ChainableBinaryFunction(BinaryFunction function)

Method Summary

Modifier and Type	Method	Description
Object	apply(Evaluator ev, Node node, Object arg)	Evaluate a chained function using an additional argument.
Object	evaluate(Node node, Evaluator pv)	Performs some special evaluation on the node.
String	getDescription()	Return a description of the function from the properties file.
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.
BinaryFunction	getRootFunction()	Get the original binary function that is wrapped by this chainable function.

Methods inherited from class com.singularsys.jep.misc.overloadedfunctions.AlternateFunctions

checkNumberOfParameters, getFunctionForNArgs, init

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, getDescription, getDescriptionWithType, getName, getNumberOfParameters, run, setCurNumberOfParameters, setDescription, setName, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ChainableBinaryFunction

public ChainableBinaryFunction(BinaryFunction function)

Method Details

evaluate

public Object evaluate(Node node,
 Evaluator pv)
                throws EvaluationException

Description copied from interface: CallbackEvaluationI

Performs some special evaluation on the node. This method has the responsibility for evaluating the children of the node, and it should generally call

 pv.eval(node.jjtGetChild(i))   
 

for each child. The SymbolTable is not passed as an argument. This is because it is better practice to get and set variable values by using node.getVar().setValue() rather that through the SymbolTable with requires a hashtable lookup.

Specified by:

evaluate in interface CallbackEvaluationI

Overrides:

evaluate in class AlternateFunctions

Parameters:

node - The current node

pv - The visitor, can be used evaluate the children

Returns:

the value after evaluation. This value will be passed to other functions higher up the node tree. The value can be any type including Double or Vector<Object>

Throws:

EvaluationException - if the calculation cannot be performed

See Also:

• Evaluator

apply

public Object apply(Evaluator ev,
 Node node,
 Object arg)
             throws EvaluationException

Description copied from interface: ChainedFunctionI

Evaluate a chained function using an additional argument.

Specified by:

apply in interface ChainedFunctionI

Parameters:

ev - the evaluator

node - top node of function

arg - additional argument from previous element in the chain

Returns:

Throws:

EvaluationException

getLightWeightInstance

public JepComponent getLightWeightInstance()

Description copied from interface: JepComponent

Gets a light-weight instance suitable for using in multiple threads.

Specified by:

getLightWeightInstance in interface JepComponent

Overrides:

getLightWeightInstance in class AlternateFunctions

Returns:

either a new instance, null or 'this'.

getDescription

public String getDescription()

Description copied from class: PostfixMathCommand

Return a description of the function from the properties file. The property name is the class name followed by ".description". The property is found using the JepMessages class, which can be configured to add additional properties files. If PostfixMathCommand.setDescription(String) has been called, return the description set by that method instead.

Specified by:

getDescription in interface PostfixMathCommandI

Overrides:

getDescription in class AlternateFunctions

Returns:

the description of the function

getRootFunction

public BinaryFunction getRootFunction()

Get the original binary function that is wrapped by this chainable function.

Returns:

the original binary function