Package com.singularsys.extensions.lambda

Class MatrixListProcessor

java.lang.Object

com.singularsys.extensions.lambda.StandardListProcessor

com.singularsys.extensions.lambda.MatrixListProcessor

All Implemented Interfaces:

ListProcessor, JepComponent, Serializable

public class MatrixListProcessor
extends StandardListProcessor

A list processor which accepts and produces VectorI arguments. All elements in the list are assumed to be the same length.

Two nested types MatrixListProcessor.MatrixRowsIterable and MatrixListProcessor.MatrixColsIterable return iterable views of the rows and columns of a matrix.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatrixListProcessor.MatrixColsIterable	An Iterable over the columns of a MatrixI.
static class	MatrixListProcessor.MatrixRowsIterable	An Iterable over the rows of a MatrixI.

Field Summary

Fields

Modifier and Type	Field	Description
protected final FieldI	field
protected final MatrixFactoryI	mf

Constructor Summary

Constructors

Constructor	Description
MatrixListProcessor(MatrixFactoryI mf, FieldI baseField)

Method Summary

Modifier and Type	Method	Description
Iterable<Object>	fromArgs(Object arg)	Returns an Iterable over the input arguments.
Object	fromCollection(Collection<Object> tree)	Convert a general collection into a type used the Jep environment.
Object	fromList(List<Object> list)	Convert a list produced by ListProcessor.makeList() to the type used by Jep environment.
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.
void	init(Jep jep)	Initialize the component.
List<Object>	makeList()	Get an empty list which elements can be added.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

mf

protected final MatrixFactoryI mf

field

protected final FieldI field

Constructor Details

MatrixListProcessor

public MatrixListProcessor(MatrixFactoryI mf,
 FieldI baseField)

Method Details

init

public void init(Jep jep)

Description copied from interface: JepComponent

Initialize the component. This method is called whenever a component is added to Jep. Hence, it allows components to keep track of the other components they may rely on.

Specified by:

init in interface JepComponent

Overrides:

init in class StandardListProcessor

Parameters:

jep - the current Jep instance

getLightWeightInstance

public JepComponent getLightWeightInstance()

Description copied from interface: JepComponent

Gets a light-weight instance suitable for using in multiple threads.

Specified by:

getLightWeightInstance in interface JepComponent

Overrides:

getLightWeightInstance in class StandardListProcessor

Returns:

either a new instance, null or 'this'.

fromArgs

public Iterable<Object> fromArgs(Object arg)
                          throws EvaluationException

Returns an Iterable over the input arguments.

Specified by:

fromArgs in interface ListProcessor

Overrides:

fromArgs in class StandardListProcessor

Parameters:

arg - an input to the function. Expects an argument of type VectorI or MatrixI.

Returns:

a PaddingListProcessor.VectorIterable or MatrixListProcessor.MatrixRowsIterable

Throws:

EvaluationException - if argument is not of type VectorI or MatrixI

makeList

public List<Object> makeList()

Description copied from interface: ListProcessor

Get an empty list which elements can be added.

Specified by:

makeList in interface ListProcessor

Overrides:

makeList in class StandardListProcessor

Returns:

an empty list

fromList

public Object fromList(List<Object> list)
                throws EvaluationException

Description copied from interface: ListProcessor

Convert a list produced by ListProcessor.makeList() to the type used by Jep environment. Some implementations just return the input.

Specified by:

fromList in interface ListProcessor

Overrides:

fromList in class StandardListProcessor

Parameters:

list - a list

Returns:

a type suitable for use by Jep.

Throws:

EvaluationException - on error

fromCollection

public Object fromCollection(Collection<Object> tree)
                      throws EvaluationException

Description copied from interface: ListProcessor

Convert a general collection into a type used the Jep environment.

Specified by:

fromCollection in interface ListProcessor

Overrides:

fromCollection in class StandardListProcessor

Parameters:

tree - input collection

Returns:

a type suitable for use by Jep

Throws:

EvaluationException - on error