JAL-2403 ensure array held in Matrix is immutable
[jalview.git] / src / jalview / math / Matrix.java
index 0f93eb5..b39d3c9 100755 (executable)
@@ -26,15 +26,12 @@ import jalview.util.MessageManager;
 import java.io.PrintStream;
 
 /**
- * DOCUMENT ME!
- * 
- * @author $author$
- * @version $Revision$
+ * A class to model rectangular matrices of double values and operations on them
  */
 public class Matrix implements MatrixI
 {
   /*
-   * the [row][column] values in the matrix
+   * the cell values in row-major order
    */
   private double[][] value;
 
@@ -48,10 +45,8 @@ public class Matrix implements MatrixI
    */
   protected int cols;
 
-  /** DOCUMENT ME!! */
   protected double[] d; // Diagonal
 
-  /** DOCUMENT ME!! */
   protected double[] e; // off diagonal
 
   /**
@@ -70,7 +65,8 @@ public class Matrix implements MatrixI
   }
   
   /**
-   * Creates a new Matrix object. For example
+   * Creates a new Matrix object containing a copy of the supplied array values.
+   * For example
    * 
    * <pre>
    *   new Matrix(new double[][] {{2, 3, 4}, {5, 6, 7})
@@ -89,17 +85,28 @@ public class Matrix implements MatrixI
   public Matrix(double[][] values)
   {
     this.rows = values.length;
-    if (rows > 0)
+    this.cols = this.rows == 0 ? 0 : values[0].length;
+
+    /*
+     * make a copy of the values array, for immutability
+     */
+    this.value = new double[rows][];
+    int i = 0;
+    for (double[] row : values)
     {
-      this.cols = values[0].length;
+      if (row != null)
+      {
+        value[i] = new double[row.length];
+        System.arraycopy(row, 0, value[i], 0, row.length);
+      }
+      i++;
     }
-    this.value = values;
   }
 
   /**
    * Returns a new matrix which is the transpose of this one
    * 
-   * @return DOCUMENT ME!
+   * @return
    */
   @Override
   public MatrixI transpose()
@@ -275,27 +282,22 @@ public class Matrix implements MatrixI
       {
         for (k = 1; k <= l; k++)
         {
-          // double v = Math.abs(value[i - 1][k - 1]);
           double v = Math.abs(getValue(i - 1, k - 1));
           scale += v;
         }
 
         if (scale == 0.0)
         {
-          // e[i - 1] = value[i - 1][l - 1];
           e[i - 1] = getValue(i - 1, l - 1);
         }
         else
         {
           for (k = 1; k <= l; k++)
           {
-            // value[i - 1][k - 1] /= scale;
-            // h += (value[i - 1][k - 1] * value[i - 1][k - 1]);
             double v = divideValue(i - 1, k - 1, scale);
             h += v * v;
           }
 
-          // f = value[i - 1][l - 1];
           f = getValue(i - 1, l - 1);
 
           if (f > 0)
@@ -309,34 +311,26 @@ public class Matrix implements MatrixI
 
           e[i - 1] = scale * g;
           h -= (f * g);
-          // value[i - 1][l - 1] = f - g;
           setValue(i - 1, l - 1, f - g);
-          // System.out.println(String.format("%d %d %f %f %f %f %f %.5e", i,
-          // l,
-          // scale, f, g, h, getValue(i - 1, l - 1), checksum()));
           f = 0.0;
 
           for (j = 1; j <= l; j++)
           {
-            // value[j - 1][i - 1] = value[i - 1][j - 1] / h;
             double val = getValue(i - 1, j - 1) / h;
             setValue(j - 1, i - 1, val);
             g = 0.0;
 
             for (k = 1; k <= j; k++)
             {
-              // g += (value[j - 1][k - 1] * value[i - 1][k - 1]);
               g += (getValue(j - 1, k - 1) * getValue(i - 1, k - 1));
             }
 
             for (k = j + 1; k <= l; k++)
             {
-              // g += (value[k - 1][j - 1] * value[i - 1][k - 1]);
               g += (getValue(k - 1, j - 1) * getValue(i - 1, k - 1));
             }
 
             e[j - 1] = g / h;
-            // f += (e[j - 1] * value[i - 1][j - 1]);
             f += (e[j - 1] * getValue(i - 1, j - 1));
           }
 
@@ -344,15 +338,12 @@ public class Matrix implements MatrixI
 
           for (j = 1; j <= l; j++)
           {
-            // f = value[i - 1][j - 1];
             f = getValue(i - 1, j - 1);
             g = e[j - 1] - (hh * f);
             e[j - 1] = g;
 
             for (k = 1; k <= j; k++)
             {
-              // value[j - 1][k - 1] -= ((f * e[k - 1]) + (g * value[i - 1][k -
-              // 1]));
               double val = (f * e[k - 1]) + (g * getValue(i - 1, k - 1));
               addValue(j - 1, k - 1, -val);
             }
@@ -361,7 +352,6 @@ public class Matrix implements MatrixI
       }
       else
       {
-        // e[i - 1] = value[i - 1][l - 1];
         e[i - 1] = getValue(i - 1, l - 1);
       }
 
@@ -383,27 +373,21 @@ public class Matrix implements MatrixI
 
           for (k = 1; k <= l; k++)
           {
-            // g += (value[i - 1][k - 1] * value[k - 1][j - 1]);
             g += (getValue(i - 1, k - 1) * getValue(k - 1, j - 1));
           }
 
           for (k = 1; k <= l; k++)
           {
-            // value[k - 1][j - 1] -= (g * value[k - 1][i - 1]);
             addValue(k - 1, j - 1, -(g * getValue(k - 1, i - 1)));
           }
         }
       }
 
-      // d[i - 1] = value[i - 1][i - 1];
-      // value[i - 1][i - 1] = 1.0;
       d[i - 1] = getValue(i - 1, i - 1);
       setValue(i - 1, i - 1, 1.0);
 
       for (j = 1; j <= l; j++)
       {
-        // value[j - 1][i - 1] = 0.0;
-        // value[i - 1][j - 1] = 0.0;
         setValue(j - 1, i - 1, 0.0);
         setValue(i - 1, j - 1, 0.0);
       }
@@ -543,9 +527,6 @@ public class Matrix implements MatrixI
 
             for (k = 1; k <= n; k++)
             {
-              // f = value[k - 1][i];
-              // value[k - 1][i] = (s * value[k - 1][i - 1]) + (c * f);
-              // value[k - 1][i - 1] = (c * value[k - 1][i - 1]) - (s * f);
               f = getValue(k - 1, i);
               setValue(k - 1, i, (s * getValue(k - 1, i - 1)) + (c * f));
               setValue(k - 1, i - 1, (c * getValue(k - 1, i - 1)) - (s * f));
@@ -566,6 +547,7 @@ public class Matrix implements MatrixI
     return value[i][j];
   }
 
+  @Override
   public void setValue(int i, int j, double val)
   {
     value[i][j] = val;
@@ -923,4 +905,91 @@ public class Matrix implements MatrixI
     System.arraycopy(value[i], 0, row, 0, cols);
     return row;
   }
+
+  /**
+   * Returns a length 2 array of {minValue, maxValue} of all values in the
+   * matrix. Returns null if the matrix is null or empty.
+   * 
+   * @return
+   */
+  double[] findMinMax()
+  {
+    if (value == null)
+    {
+      return null;
+    }
+    double min = Double.MAX_VALUE;
+    double max = -Double.MAX_VALUE;
+    boolean empty = true;
+    for (double[] row : value)
+    {
+      if (row != null)
+      {
+        for (double x : row)
+        {
+          empty = false;
+          if (x > max)
+          {
+            max = x;
+          }
+          if (x < min)
+          {
+            min = x;
+          }
+        }
+      }
+    }
+    return empty ? null : new double[] { min, max };
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public void reverseRange(boolean maxToZero)
+  {
+    if (value == null)
+    {
+      return;
+    }
+    double[] minMax = findMinMax();
+    if (minMax == null)
+    {
+      return; // empty matrix
+    }
+    double subtractFrom = maxToZero ? minMax[1] : minMax[0] + minMax[1];
+
+    for (double[] row : value)
+    {
+      if (row != null)
+      {
+        int j = 0;
+        for (double x : row)
+        {
+          row[j] = subtractFrom - x;
+          j++;
+        }
+      }
+    }
+  }
+
+  /**
+   * Multiplies every entry in the matrix by the given value.
+   * 
+   * @param
+   */
+  @Override
+  public void multiply(double by)
+  {
+    for (double[] row : value)
+    {
+      if (row != null)
+      {
+        for (int i = 0; i < row.length; i++)
+        {
+          row[i] *= by;
+        }
+      }
+    }
+  }
 }