com.singularsys.extensions.matrix

Class DimensionVisitor

java.lang.Object

com.singularsys.extensions.matrix.DimensionVisitor

All Implemented Interfaces:

JepComponent, ParserVisitor, java.io.Serializable

Direct Known Subclasses:

DDimensionVisitor

public class DimensionVisitor
extends java.lang.Object
implements ParserVisitor, JepComponent

Annotates nodes with the dimension of the vector or matrix.

Warning messages are sometimes generated. This list can

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Node.HookKey	DIM_KEY A Key to use with Nodes and Variables to store the dimensions.

Constructor Summary

Constructors

Constructor and Description
DimensionVisitor() Should only be used as when the init(Jep) will be called.
DimensionVisitor(Jep jep1)

Method Summary

Modifier and Type	Method and Description
static Dimensions	getDimByValue(java.lang.Object val)
JepComponent	getLightWeightInstance() Gets a light-weight instance suitable for using in multiple threads.
java.util.List<java.lang.String>	getWarnings() The list of warnings when a variable has changed dimension.
void	init(Jep jep1) Initialize the component.
Dimensions	visit(ASTConstant node, java.lang.Object data)
Dimensions	visit(ASTFunNode node, java.lang.Object data)
Dimensions	visit(ASTOpNode node, java.lang.Object data)
Dimensions	visit(ASTVarNode node, java.lang.Object data)
Dimensions	visit(Node node) Annotate every node in the tree.
protected Dimensions	visitAssign(ASTOpNode node, java.lang.Object data)

Methods inherited from class java.lang.Object

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

Field Detail

DIM_KEY

public static final Node.HookKey DIM_KEY

A Key to use with Nodes and Variables to store the dimensions.

Constructor Detail

DimensionVisitor

public DimensionVisitor()

Should only be used as when the init(Jep) will be called.

DimensionVisitor

public DimensionVisitor(Jep jep1)

Method Detail

getDimByValue

public static final Dimensions getDimByValue(java.lang.Object val)

visit

public Dimensions visit(Node node)
                 throws ParseException

Annotate every node in the tree.

Parameters:

node - root node of the expression

Returns:

dimensions of the root node

Throws:

ParseException

visit

public Dimensions visit(ASTConstant node,
                        java.lang.Object data)
                 throws ParseException

Specified by:

visit in interface ParserVisitor

Throws:

ParseException

visit

public Dimensions visit(ASTVarNode node,
                        java.lang.Object data)
                 throws ParseException

Specified by:

visit in interface ParserVisitor

Throws:

ParseException

visitAssign

protected Dimensions visitAssign(ASTOpNode node,
                                 java.lang.Object data)
                          throws ParseException

Throws:

ParseException

visit

public Dimensions visit(ASTFunNode node,
                        java.lang.Object data)
                 throws ParseException

Specified by:

visit in interface ParserVisitor

Throws:

ParseException

visit

public Dimensions visit(ASTOpNode node,
                        java.lang.Object data)
                 throws ParseException

Specified by:

visit in interface ParserVisitor

Throws:

ParseException

getWarnings

public java.util.List<java.lang.String> getWarnings()

The list of warnings when a variable has changed dimension.

Returns:

init

public void init(Jep jep1)

Description copied from interface: JepComponent

Initialize the component. This methods 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

Parameters:

jep1 - 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

Returns:

either an new instance, or 'this'.