Package com.singularsys.extensions.matrix.dictionary

Class MatrixDictGetOr

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.NaryFunction

com.singularsys.jep.misc.dictionary.GetOr

com.singularsys.extensions.matrix.dictionary.MatrixDictGetOr

All Implemented Interfaces:

PostfixMathCommandI, Serializable

public class MatrixDictGetOr
extends GetOr

Implementation of GetOr compatible with the matrix package. This version uses FieldI.eq(Object, Object) to tests keys for equality so it can also be used with the com.singularsys.extensions.field package.

Allows

mat = [['x',2], ['y',3], ['z',4]];
getOr(mat,'x',-1);

Since:

4.1 extensions 2.2

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldI	mf

Fields inherited from class com.singularsys.jep.misc.dictionary.GetOr

nullValue

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixDictGetOr(Object nullValue, FieldI mf)

Method Summary

Modifier and Type	Method	Description
protected boolean	equals(Object key, Object k)	Test if key equals k.
protected Object	eval(MatrixI mat, Object key, Object val)
protected Object	eval(VectorI vec, Object key, Object val)
Object	eval(Object[] args)	Evaluate the function

Methods inherited from class com.singularsys.jep.misc.dictionary.GetOr

eval, eval

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, 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

Field Details

mf

protected FieldI mf

Constructor Details

MatrixDictGetOr

public MatrixDictGetOr(Object nullValue,
 FieldI mf)

Method Details

eval

public Object eval(Object[] args)
            throws EvaluationException

Description copied from class: NaryFunction

Evaluate the function

Overrides:

eval in class GetOr

Parameters:

args - arguments to the function

Returns:

value returned by the function

Throws:

EvaluationException - if the calculation cannot be performed

eval

protected Object eval(MatrixI mat,
 Object key,
 Object val)
               throws EvaluationException

Throws:

EvaluationException

eval

protected Object eval(VectorI vec,
 Object key,
 Object val)
               throws EvaluationException

Throws:

EvaluationException

equals

protected boolean equals(Object key,
 Object k)
                  throws EvaluationException

Description copied from class: GetOr

Test if key equals k. Default implementation uses key.equals(k)

Overrides:

equals in class GetOr

Parameters:

key - key to test

k - key to test

Returns:

true if parameters are equal

Throws:

EvaluationException