Package com.singularsys.extensions.matrix.functions

Class MatrixTrace

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.extensions.matrix.functions.MatrixTrace

All Implemented Interfaces:

MatrixFunctionI, PostfixMathCommandI, Serializable

public class MatrixTrace
extends UnaryFunction
implements MatrixFunctionI

Calculate the trace of a matrix using a MatrixField.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.functions.UnaryFunction

UnaryFunction.FunctionWithException<T>

Field Summary

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixTrace(MatrixFieldI mfact)

Method Summary

Modifier and Type	Method	Description
Dimensions	calcDims(Dimensions... inDims)	Attempts to calculate the dimensions of a result of a PostfixMathCommand.
Object	eval(Object arg)	Evaluate the function
Object	trace(Object param)

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

instanceOf, instanceOf, instanceOf, instanceOf, run

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

MatrixTrace

public MatrixTrace(MatrixFieldI mfact)

Parameters:

mfact -

Method Details

trace

public Object trace(Object param)
             throws EvaluationException

Throws:

EvaluationException

eval

public Object eval(Object arg)
            throws EvaluationException

Description copied from class: UnaryFunction

Evaluate the function

Specified by:

eval in class UnaryFunction

Parameters:

arg - the single argument passed in

Returns:

the result of the function

Throws:

EvaluationException - on error

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 it cannot be calculated

Throws:

ParseException - if there is a parse error