Package com.singularsys.extensions.matrix.dictionary

Class MatrixDictRemove

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.jep.misc.dictionary.Remove

com.singularsys.extensions.matrix.dictionary.MatrixDictRemove

All Implemented Interfaces:

PostfixMathCommandI, Serializable

public class MatrixDictRemove
extends Remove

Removes entries with matching key from the map. 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:

map = {'x':2, 'y':3};
remove(map, 'x');

The function returns either the value or the removed key or Remove.nullValue if the key is missing the key has no value.

Since:

Jep 4.1

See Also:

• Serialized Form

Nested Class Summary

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

BinaryFunction.BiFunctionWithException<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldI	mf

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

nullValue

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixDictRemove(Object nullValue, FieldI mf)	Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	equals(Object key, Object k)	Test if key equals k.

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

eval, eval, eval

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

Field Details

mf

protected FieldI mf

Constructor Details

MatrixDictRemove

public MatrixDictRemove(Object nullValue,
 FieldI mf)

Constructor

Parameters:

nullValue - , value returned when a key has no value or if no key exists.

Method Details

equals

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

Description copied from class: Remove

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

Overrides:

equals in class Remove

Parameters:

key - key to test

k - key to test

Returns:

true if parameters are equal

Throws:

EvaluationException