com.singularsys.extensions.matrix.functions

Class MatrixId

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.NaryFunction

com.singularsys.extensions.matrix.functions.MatrixId

All Implemented Interfaces:

MatrixFunctionI, PostfixMathCommandI, java.io.Serializable

public class MatrixId
extends NaryFunction
implements MatrixFunctionI

Generates identity matrices. id(2) will generate a 2 by 2 identity. id(3,2) will generate a 3 by 2 matrix with ones down the principal diagonal.

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
MatrixId(MatrixFactoryI mfact, IntegerConvertor conv)

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

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

run

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

MatrixId

public MatrixId(MatrixFactoryI mfact,
                IntegerConvertor conv)

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

calcDims

public Dimensions calcDims(Dimensions... inDims)

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