MatrixTrace (Jep with extensions API )

java.lang.Object
- com.singularsys.jep.functions.PostfixMathCommand
- - com.singularsys.jep.functions.UnaryFunction
  - - com.singularsys.extensions.matrix.functions.MatrixTrace

All Implemented Interfaces:

MatrixFunctionI, PostfixMathCommandI, java.io.Serializable
```
public class MatrixTrace
extends UnaryFunction
implements MatrixFunctionI
```
Calculate the trace of a matrix using a MatrixField.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
  curNumberOfParameters, name, NaN, numberOfParameters

Constructor Summary

Constructors
Constructor Description

MatrixTrace(MatrixFieldI mfact)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Dimensions`	`calcDims(Dimensions... inDims)`	Attempts to calculate the dimensions of a result of a PostfixMathCommand.
`java.lang.Object`	`eval(java.lang.Object arg)`
`java.lang.Object`	`trace(java.lang.Object param)`

Methods inherited from class com.singularsys.jep.functions.UnaryFunction
instanceOf, instanceOf, run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand
asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, checkNumberOfParameters, 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
  - MatrixTrace
```
public MatrixTrace(MatrixFieldI mfact)
```
    Parameters:
    
    mfact -
- Method Detail
  - trace
```
public java.lang.Object trace(java.lang.Object param)
                       throws EvaluationException
```
    Throws:
    
    EvaluationException
  - eval
```
public java.lang.Object eval(java.lang.Object arg)
                      throws EvaluationException
```
    Specified by:
    
    eval in class UnaryFunction
    
    Throws:
    
    EvaluationException
  - 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