Package com.singularsys.extensions.chained

Class ChainableGeneralFunction

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.misc.overloadedfunctions.OverloadedFunctionByStructure

com.singularsys.extensions.chained.ChainableGeneralFunction

All Implemented Interfaces:

ChainedFunctionI, DirtyFunction, CallbackEvaluationI, JepComponent, PostfixMathCommandI, Serializable

public class ChainableGeneralFunction
extends OverloadedFunctionByStructure
implements ChainedFunctionI, DirtyFunction

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

See Also:

• Serialized Form

Field Summary

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

argTest, function1, function2, nf, ot

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
ChainableGeneralFunction(ChainedFunctionI function1, PostfixMathCommandI function2, Predicate<Node> argTest)	Constructor.

Method Summary

Modifier and Type	Method	Description
Object	apply(Evaluator ev, Node node, Object arg)	Evaluate a chained function using an additional argument.
ChainedFunctionI	getChainedFunction()	Get the chained version of the function.
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.
PostfixMathCommandI	getRootFunction()	Get the un-chained function.

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

checkNumberOfParameters, evaluate, getFunction1, getFunction2, getFunctionFor, getNumberOfParameters, getPredicate, init

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

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, getDescription, getDescriptionWithType, getName, 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

ChainableGeneralFunction

public ChainableGeneralFunction(ChainedFunctionI function1,
 PostfixMathCommandI function2,
 Predicate<Node> argTest)

Constructor.

Parameters:

function1 - the function to use in a chain, must implement ChainedFunctionI

function2 - the function to use when not in a chain, must implement PostfixMathCommandI

argTest - a predicate that tests the structure of the parse tree, the first function is used if this returns true.

Method Details

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 OverloadedFunctionByStructure

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 OverloadedFunctionByStructure

Returns:

the description of the function

getRootFunction

public PostfixMathCommandI getRootFunction()

Get the un-chained function.

Returns:

the second argument in the constructor

getChainedFunction

public ChainedFunctionI getChainedFunction()

Get the chained version of the function.

Returns:

the chained function