org.lsmp.djep.matrixJep
Interface MatrixVariableI

All Known Implementing Classes:

MatrixPartialDerivative, MatrixVariable

public interface MatrixVariableI

Matrix aware variables should implement this interface.

Author:

Rich Morris Created on 19-Dec-2003

Method Summary

Dimensions	getDimensions() The dimension of the variable.
Node	getEquation() The equation represented by this variable.
MatrixValueI	getMValue() Returns the value container of this variable.
boolean	hasValidValue() Is the value of this variable meaningful?
void	setDimensions(Dimensions dims) Sets the dimension of the variable.
void	setMValue(MatrixValueI val) Sets the value of the variable (matrix aware).
void	setValidValue(boolean b) makes the vaule valid.

Method Detail

getDimensions

public Dimensions getDimensions()

The dimension of the variable.

setDimensions

public void setDimensions(Dimensions dims)

Sets the dimension of the variable. Will also allocate appropriate space for value container.

getMValue

public MatrixValueI getMValue()

Returns the value container of this variable. There is no setMValue as the value can be changed by setting the individual elements of value container.

setMValue

public void setMValue(MatrixValueI val)

Sets the value of the variable (matrix aware).

hasValidValue

public boolean hasValidValue()

Is the value of this variable meaningful?

setValidValue

public void setValidValue(boolean b)

makes the vaule valid.

getEquation

public Node getEquation()

The equation represented by this variable.