com.singularsys.extensions.matrix.functions

Class MatrixList

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.NaryFunction

com.singularsys.extensions.matrix.functions.MatrixList

All Implemented Interfaces:

MatrixFunctionI, PostfixMathCommandI, java.io.Serializable

public class MatrixList
extends NaryFunction
implements MatrixFunctionI

PostfixMathCommand which takes a number of objects on the stack and creates either a matrix or a vector.

See Also:

Serialized Form

Field Summary

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

curNumberOfParameters, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor and Description
MatrixList(MatrixFactoryI mf)

Method Summary

Modifier and Type	Method and Description
Dimensions	calcDims(Dimensions... inDims) Attempts to calculate the dimensions of a result of a PostfixMathCommand.
boolean	checkNumberOfParameters(int n) Checks the number of parameters of the function.
java.lang.Object	eval(java.lang.Object[] args) Evaluate the function
void	run(java.util.Stack<java.lang.Object> stack) Creates an array of object then calls NaryFunction.eval(Object[])

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

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MatrixList

public MatrixList(MatrixFactoryI mf)

Parameters:

mf -

Method Detail

checkNumberOfParameters

public boolean checkNumberOfParameters(int n)

Description copied from class: PostfixMathCommand

Checks the number of parameters of the function. Functions which set numberOfParameter=-1 should overload this method

Specified by:

checkNumberOfParameters in interface PostfixMathCommandI

Overrides:

checkNumberOfParameters in class PostfixMathCommand

Parameters:

n - number of parameters function will be called with.

Returns:

false if an illegal number of parameters is supplied, true otherwise.

eval

public java.lang.Object eval(java.lang.Object[] args)
                      throws EvaluationException

Description copied from class: NaryFunction

Evaluate the function

Specified by:

eval in class NaryFunction

Parameters:

args - arguments to the function

Returns:

value returned by the function

Throws:

EvaluationException - if the calculation cannot be performed

run

public void run(java.util.Stack<java.lang.Object> stack)
         throws EvaluationException

Description copied from class: NaryFunction

Creates an array of object then calls NaryFunction.eval(Object[])

Specified by:

run in interface PostfixMathCommandI

Overrides:

run in class NaryFunction

Parameters:

stack - arguments for function

Throws:

EvaluationException - if function cannot be evaluated

calcDims

public Dimensions calcDims(Dimensions... inDims)
                    throws ParseException

Description copied from interface: MatrixFunctionI

Attempts to calculate the dimensions of a result of a PostfixMathCommand.

Specified by:

calcDims in interface MatrixFunctionI

Parameters:

inDims - the dimensions of each argument

Returns:

the dimension of the result or null if can be calculated

Throws:

ParseException - if there is a parse error