Package com.singularsys.extensions.matrix.dictionary

Class MatrixDictPut

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.NaryFunction

com.singularsys.jep.misc.dictionary.Put

com.singularsys.extensions.matrix.dictionary.MatrixDictPut

All Implemented Interfaces:

ZeroLengthBehaviourI, ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI, PostfixMathCommandI, Serializable

public class MatrixDictPut
extends Put
implements ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

Implementation of Put 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]];
put(mat,'x',5);

If the key is not in the map it will throw an EvaluationsException.

Since:

4.1 extensions 2.2

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.misc.dictionary.Put

Put.Type

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
protected ZeroLengthBehaviourI.ZeroLengthHelper	zeroLengthHelper

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

nullValue, type

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixDictPut(Put.Type type, 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
String	getErrorMessage(String name)	Gets the zero length error message.
ZeroLengthBehaviourI	getZeroLengthHelper()	Gets the helper class which implements the zero length behaviour.

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

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

zeroLengthHelper

protected ZeroLengthBehaviourI.ZeroLengthHelper zeroLengthHelper

Constructor Details

MatrixDictPut

public MatrixDictPut(Put.Type type,
 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 Put

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: Put

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

Overrides:

equals in class Put

Parameters:

key - key to test

k - key to test

Returns:

true if parameters are equal

Throws:

EvaluationException

getZeroLengthHelper

public ZeroLengthBehaviourI getZeroLengthHelper()

Description copied from interface: ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

Gets the helper class which implements the zero length behaviour. The standard implementation is:

ZeroLengthHelper zeroLengthHelper = new ZeroLengthHelper();
@Override
public ZeroLengthBehaviourI getZeroLengthHelper() {
    return zeroLengthHelper;
}

Specified by:

getZeroLengthHelper in interface ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

Returns:

the helper class

getErrorMessage

public String getErrorMessage(String name)

Description copied from interface: ZeroLengthBehaviourI

Gets the zero length error message. The default implementation format a string using the functions.AtLestOneArgumentIsRequired property.

Specified by:

getErrorMessage in interface ZeroLengthBehaviourI

Parameters:

name - name of the function passed into ZeroLengthBehaviourI.zeroLengthResultOrException(String)

Returns:

the error message.