Package com.singularsys.extensions.matrix.dictionary

Class MatrixDictEntriesIterable

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.extensions.matrix.dictionary.MatrixDictEntriesIterable

All Implemented Interfaces:

PostfixMathCommandI, Serializable

Direct Known Subclasses:

StreamMatrixEntries

public class MatrixDictEntriesIterable
extends UnaryFunction

Matrix compatible versions of the EntriesIterable function. Returns an Iterable<VectorI> for the entries of a map. Each item returned by a iterator is a VectorI with 2 elements: the key and value. If no value is associate with the key then nullValue is used.

Since:

Jep 4.1

See Also:

• Serialized Form

Nested Class Summary

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

UnaryFunction.FunctionWithException<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final MatrixFactoryI	mf
protected final Object	nullValue

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
MatrixDictEntriesIterable(Object nullValue, MatrixFactoryI mf)	Constructor

Method Summary

Modifier and Type	Method	Description
protected Iterable<VectorI>	eval(MatrixI mat)
protected Iterable<VectorI>	eval(VectorI vec)
Object	eval(Object l)	Evaluate the function
protected Iterable<VectorI>	eval(List<Object> list)
protected Iterable<VectorI>	eval(Map<Object,Object> map)

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

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

nullValue

protected final Object nullValue

mf

protected final MatrixFactoryI mf

Constructor Details

MatrixDictEntriesIterable

public MatrixDictEntriesIterable(Object nullValue,
 MatrixFactoryI mf)

Constructor

Parameters:

nullValue - , value for a key has no value.

mf - the MatrixFactory used to create entries.

Method Details

eval

public Object eval(Object l)
            throws EvaluationException

Description copied from class: UnaryFunction

Evaluate the function

Specified by:

eval in class UnaryFunction

Parameters:

l - the single argument passed in

Returns:

the result of the function

Throws:

EvaluationException - on error

eval

protected Iterable<VectorI> eval(MatrixI mat)
                          throws EvaluationException

Throws:

EvaluationException

eval

protected Iterable<VectorI> eval(VectorI vec)
                          throws EvaluationException

Throws:

EvaluationException

eval

protected Iterable<VectorI> eval(List<Object> list)
                          throws EvaluationException

Throws:

EvaluationException

eval

protected Iterable<VectorI> eval(Map<Object,Object> map)
                          throws EvaluationException

Throws:

EvaluationException