Package com.singularsys.extensions.matrix.dictionary

Class MatrixDictGet

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.jep.misc.dictionary.Get

com.singularsys.extensions.matrix.dictionary.MatrixDictGet

All Implemented Interfaces:

ZeroLengthBehaviourI, ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI, PostfixMathCommandI, Serializable

public class MatrixDictGet
extends Get

Implementation of Get 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]];
get(mat,'x');

Return value when key is missing is controlled by the ZeroLenghtBehaviour.

Since:

4.1 extensions 2.2

See Also:

• Serialized Form

Nested Class Summary

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

BinaryFunction.BiFunctionWithException<T>

Nested classes/interfaces inherited from interface com.singularsys.jep.functions.ZeroLengthBehaviourI

ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI, ZeroLengthBehaviourI.ZeroLengthErrorBehaviour, ZeroLengthBehaviourI.ZeroLengthHelper

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldI	mf

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

nullValue, zeroLengthHelper

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixDictGet(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)
protected Object	eval(VectorI vec, Object key)
Object	eval(Object l, Object key)	Evaluate the function

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

eval, eval, getErrorMessage, getZeroLengthHelper

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

Methods inherited from interface com.singularsys.jep.functions.ZeroLengthBehaviourI

getValueOrException, zeroLengthResultOrException

Methods inherited from interface com.singularsys.jep.functions.ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

getZeroLengthErrorBehaviour, getZeroLengthValue, setZeroLengthErrorBehaviour, setZeroLengthValue

Field Details

mf

protected FieldI mf

Constructor Details

MatrixDictGet

public MatrixDictGet(Object nullValue,
 FieldI mf)

Method Details

eval

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

Description copied from class: BinaryFunction

Evaluate the function

Overrides:

eval in class Get

Parameters:

l - lhs argument

key - rhs argument

Returns:

the results

Throws:

EvaluationException - if the function cannot be evaluated.

eval

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

Throws:

EvaluationException

eval

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

Throws:

EvaluationException

equals

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

Description copied from class: Get

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

Overrides:

equals in class Get

Parameters:

key - key to test

k - key to test

Returns:

true if parameters are equal

Throws:

EvaluationException