KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > lsmp > djep > matrixJep > MatrixVariableI


1 /* @author rich
2  * Created on 19-Dec-2003
3  *
4  * This code is covered by a Creative Commons
5  * Attribution, Non Commercial, Share Alike license
6  * <a HREF="http://creativecommons.org/licenses/by-nc-sa/1.0">License</a>
7  */
8 package org.lsmp.djep.matrixJep;
9 import org.nfunk.jep.*;
10 import org.lsmp.djep.vectorJep.*;
11 import org.lsmp.djep.vectorJep.values.MatrixValueI;
12
13 /**
14  * Matrix aware variables should implement this interface.
15  * @author Rich Morris
16  * Created on 19-Dec-2003
17  */
18 public interface MatrixVariableI {
19     /** The dimension of the variable. */
20     public abstract Dimensions getDimensions();
21     /** Sets the dimension of the variable.
22      * Will also allocate appropriate space for value container.
23      */
24     public abstract void setDimensions(Dimensions dims);
25     /** Returns the value container of this variable.
26      * There is no setMValue as the value can be changed by
27      * setting the individual elements of value container.
28      */
29     public abstract MatrixValueI getMValue();
30     /** Sets the value of the variable (matrix aware). */
31     public abstract void setMValue(MatrixValueI val);
32     /** Is the value of this variable meaningful? */
33     public abstract boolean hasValidValue();
34     /** makes the vaule valid. */
35     public abstract void setValidValue(boolean b);
36     /** The equation represented by this variable. */
37     public abstract Node getEquation();
38 }
39
Popular Tags