Package com.singularsys.extensions.matrix.functions

Class MatrixMod

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.extensions.matrix.functions.MatrixMod

All Implemented Interfaces:

MatrixFunctionI, PostfixMathCommandI, Serializable

public class MatrixMod
extends BinaryFunction
implements MatrixFunctionI

Calculates the modulus of two elements using a MatrixField.

See Also:

• Serialized Form

Nested Class Summary

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

BinaryFunction.BiFunctionWithException<T>

Field Summary

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixMod(FieldI mfield2)

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 l, Object r)	Evaluate the function
Object	mod(Object l, Object r)

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

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

MatrixMod

public MatrixMod(FieldI mfield2)

Parameters:

mfield2 -

Method Details

mod

public Object mod(Object l,
 Object r)
           throws EvaluationException

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

Throws:

ParseException - if there is a parse error

eval

public Object eval(Object l,
 Object r)
            throws EvaluationException

Description copied from class: BinaryFunction

Evaluate the function

Specified by:

eval in class BinaryFunction

Parameters:

l - lhs argument

r - rhs argument

Returns:

the results

Throws:

EvaluationException - if the function cannot be evaluated.