Package com.singularsys.extensions.stream

Class StreamMatrixListProcessor

java.lang.Object

com.singularsys.extensions.stream.StreamListProcessor

com.singularsys.extensions.stream.StreamMatrixListProcessor

All Implemented Interfaces:

ListProcessor, JepComponent, Serializable

public class StreamMatrixListProcessor
extends StreamListProcessor

A ListProcessor implementation that can convert MatrixI, VectorI to and from streams. It is used by the stream functions to convert their arguments to streams.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StreamMatrixListProcessor(MatrixFactoryI mf, MatrixFieldI field)

Method Summary

Modifier and Type	Method	Description
Stream<Object>	argAsStream(Object arg)	Converts the argument to a stream if possible.
List<?>	argToList(Object arg)	Converts the argument to a list.
Object	argToListOrElement(Object arg)	Converts the argument to a list or single value.
Iterable<Object>	fromArgs(Object arg)	Returns an iterable view of 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 com.singularsys.extensions.stream.StreamListProcessor

car, cdr, clearClones, cloneStream

Methods inherited from class java.lang.Object

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

Constructor Details

StreamMatrixListProcessor

public StreamMatrixListProcessor(MatrixFactoryI mf,
 MatrixFieldI field)

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 StreamListProcessor

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 StreamListProcessor

Returns:

either a new instance, null or 'this'.

fromArgs

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

Description copied from interface: ListProcessor

Returns an iterable view of the input arguments.

Specified by:

fromArgs in interface ListProcessor

Overrides:

fromArgs in class StreamListProcessor

Parameters:

arg - typically a list, but can be any type. If the type is not a list, an iterator with a single element is returned.

Returns:

an Iterable view of the argument

Throws:

EvaluationException - on error

argAsStream

public Stream<Object> argAsStream(Object arg)
                           throws EvaluationException

Converts the argument to a stream if possible. If the argument is already a stream it is returned as is, if it is a list or a VectorI it is converted to a stream. Otherwise an stream consisting of a single element is created.

Overrides:

argAsStream in class StreamListProcessor

Throws:

EvaluationException

argToList

public List<?> argToList(Object arg)
                  throws EvaluationException

Converts the argument to a list. If the argument is a List, Stream or a VectorI it is converted to a list individual elements of these sequence are recursively converted to lists as well. If the argument is not a list, stream or VectorI a list consisting of a single element is created.

Overrides:

argToList in class StreamListProcessor

Parameters:

arg - the argument to convert

Returns:

a list

Throws:

EvaluationException

argToListOrElement

public Object argToListOrElement(Object arg)
                          throws EvaluationException

Converts the argument to a list or single value. If the argument is a List, Stream or a VectorI it is converted to a list individual elements of these sequence are recursively converted to lists as well. If the argument is not a list, stream or VectorI it is returned as is.

Overrides:

argToListOrElement in class StreamListProcessor

Parameters:

arg - the argument to convert

Returns:

a list or single value

Throws:

EvaluationException

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 StreamListProcessor

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 StreamListProcessor

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 StreamListProcessor

Parameters:

tree - input collection

Returns:

a type suitable for use by Jep

Throws:

EvaluationException - on error