src/jalview/math/Matrix.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.math;
  22
  23 import java.io.*;
  24
  25 import jalview.util.*;
  26
  27 /**
  28  * DOCUMENT ME!
  29  *
  30  * @author $author$
  31  * @version $Revision$
  32  */
  33 public class Matrix
  34 {
  35   /**
  36    * SMJSPUBLIC
  37    */
  38   public double[][] value;
  39
  40   /** DOCUMENT ME!! */
  41   public int rows;
  42
  43   /** DOCUMENT ME!! */
  44   public int cols;
  45
  46   /** DOCUMENT ME!! */
  47   public double[] d; // Diagonal
  48
  49   /** DOCUMENT ME!! */
  50   public double[] e; // off diagonal
  51
  52   /**
  53    * maximum number of iterations for tqli
  54    *
  55    */
  56   int maxIter = 45; // fudge - add 15 iterations, just in case
  57
  58   /**
  59    * Creates a new Matrix object.
  60    *
  61    * @param value
  62    *          DOCUMENT ME!
  63    * @param rows
  64    *          DOCUMENT ME!
  65    * @param cols
  66    *          DOCUMENT ME!
  67    */
  68   public Matrix(double[][] value, int rows, int cols)
  69   {
  70     this.rows = rows;
  71     this.cols = cols;
  72     this.value = value;
  73   }
  74
  75   /**
  76    * DOCUMENT ME!
  77    *
  78    * @return DOCUMENT ME!
  79    */
  80   public Matrix transpose()
  81   {
  82     double[][] out = new double[cols][rows];
  83
  84     for (int i = 0; i < cols; i++)
  85     {
  86       for (int j = 0; j < rows; j++)
  87       {
  88         out[i][j] = value[j][i];
  89       }
  90     }
  91
  92     return new Matrix(out, cols, rows);
  93   }
  94
  95   /**
  96    * DOCUMENT ME!
  97    *
  98    * @param ps
  99    *          DOCUMENT ME!
 100    */
 101   public void print(PrintStream ps)
 102   {
 103     for (int i = 0; i < rows; i++)
 104     {
 105       for (int j = 0; j < cols; j++)
 106       {
 107         Format.print(ps, "%8.2f", value[i][j]);
 108       }
 109
 110       ps.println();
 111     }
 112   }
 113
 114   /**
 115    * DOCUMENT ME!
 116    *
 117    * @param in
 118    *          DOCUMENT ME!
 119    *
 120    * @return DOCUMENT ME!
 121    */
 122   public Matrix preMultiply(Matrix in)
 123   {
 124     double[][] tmp = new double[in.rows][this.cols];
 125
 126     for (int i = 0; i < in.rows; i++)
 127     {
 128       for (int j = 0; j < this.cols; j++)
 129       {
 130         tmp[i][j] = 0.0;
 131
 132         for (int k = 0; k < in.cols; k++)
 133         {
 134           tmp[i][j] += (in.value[i][k] * this.value[k][j]);
 135         }
 136       }
 137     }
 138
 139     return new Matrix(tmp, in.rows, this.cols);
 140   }
 141
 142   /**
 143    * DOCUMENT ME!
 144    *
 145    * @param in
 146    *          DOCUMENT ME!
 147    *
 148    * @return DOCUMENT ME!
 149    */
 150   public double[] vectorPostMultiply(double[] in)
 151   {
 152     double[] out = new double[in.length];
 153
 154     for (int i = 0; i < in.length; i++)
 155     {
 156       out[i] = 0.0;
 157
 158       for (int k = 0; k < in.length; k++)
 159       {
 160         out[i] += (value[i][k] * in[k]);
 161       }
 162     }
 163
 164     return out;
 165   }
 166
 167   /**
 168    * DOCUMENT ME!
 169    *
 170    * @param in
 171    *          DOCUMENT ME!
 172    *
 173    * @return DOCUMENT ME!
 174    */
 175   public Matrix postMultiply(Matrix in)
 176   {
 177     double[][] out = new double[this.rows][in.cols];
 178
 179     for (int i = 0; i < this.rows; i++)
 180     {
 181       for (int j = 0; j < in.cols; j++)
 182       {
 183         out[i][j] = 0.0;
 184
 185         for (int k = 0; k < rows; k++)
 186         {
 187           out[i][j] = out[i][j] + (value[i][k] * in.value[k][j]);
 188         }
 189       }
 190     }
 191
 192     return new Matrix(out, this.cols, in.rows);
 193   }
 194
 195   /**
 196    * DOCUMENT ME!
 197    *
 198    * @return DOCUMENT ME!
 199    */
 200   public Matrix copy()
 201   {
 202     double[][] newmat = new double[rows][cols];
 203
 204     for (int i = 0; i < rows; i++)
 205     {
 206       for (int j = 0; j < cols; j++)
 207       {
 208         newmat[i][j] = value[i][j];
 209       }
 210     }
 211
 212     return new Matrix(newmat, rows, cols);
 213   }
 214
 215   /**
 216    * DOCUMENT ME!
 217    */
 218   public void tred()
 219   {
 220     int n = rows;
 221     int l;
 222     int k;
 223     int j;
 224     int i;
 225
 226     double scale;
 227     double hh;
 228     double h;
 229     double g;
 230     double f;
 231
 232     this.d = new double[rows];
 233     this.e = new double[rows];
 234
 235     for (i = n; i >= 2; i--)
 236     {
 237       l = i - 1;
 238       h = 0.0;
 239       scale = 0.0;
 240
 241       if (l > 1)
 242       {
 243         for (k = 1; k <= l; k++)
 244         {
 245           scale += Math.abs(value[i - 1][k - 1]);
 246         }
 247
 248         if (scale == 0.0)
 249         {
 250           e[i - 1] = value[i - 1][l - 1];
 251         }
 252         else
 253         {
 254           for (k = 1; k <= l; k++)
 255           {
 256             value[i - 1][k - 1] /= scale;
 257             h += (value[i - 1][k - 1] * value[i - 1][k - 1]);
 258           }
 259
 260           f = value[i - 1][l - 1];
 261
 262           if (f > 0)
 263           {
 264             g = -1.0 * Math.sqrt(h);
 265           }
 266           else
 267           {
 268             g = Math.sqrt(h);
 269           }
 270
 271           e[i - 1] = scale * g;
 272           h -= (f * g);
 273           value[i - 1][l - 1] = f - g;
 274           f = 0.0;
 275
 276           for (j = 1; j <= l; j++)
 277           {
 278             value[j - 1][i - 1] = value[i - 1][j - 1] / h;
 279             g = 0.0;
 280
 281             for (k = 1; k <= j; k++)
 282             {
 283               g += (value[j - 1][k - 1] * value[i - 1][k - 1]);
 284             }
 285
 286             for (k = j + 1; k <= l; k++)
 287             {
 288               g += (value[k - 1][j - 1] * value[i - 1][k - 1]);
 289             }
 290
 291             e[j - 1] = g / h;
 292             f += (e[j - 1] * value[i - 1][j - 1]);
 293           }
 294
 295           hh = f / (h + h);
 296
 297           for (j = 1; j <= l; j++)
 298           {
 299             f = value[i - 1][j - 1];
 300             g = e[j - 1] - (hh * f);
 301             e[j - 1] = g;
 302
 303             for (k = 1; k <= j; k++)
 304             {
 305               value[j - 1][k - 1] -= ((f * e[k - 1]) + (g * value[i - 1][k - 1]));
 306             }
 307           }
 308         }
 309       }
 310       else
 311       {
 312         e[i - 1] = value[i - 1][l - 1];
 313       }
 314
 315       d[i - 1] = h;
 316     }
 317
 318     d[0] = 0.0;
 319     e[0] = 0.0;
 320
 321     for (i = 1; i <= n; i++)
 322     {
 323       l = i - 1;
 324
 325       if (d[i - 1] != 0.0)
 326       {
 327         for (j = 1; j <= l; j++)
 328         {
 329           g = 0.0;
 330
 331           for (k = 1; k <= l; k++)
 332           {
 333             g += (value[i - 1][k - 1] * value[k - 1][j - 1]);
 334           }
 335
 336           for (k = 1; k <= l; k++)
 337           {
 338             value[k - 1][j - 1] -= (g * value[k - 1][i - 1]);
 339           }
 340         }
 341       }
 342
 343       d[i - 1] = value[i - 1][i - 1];
 344       value[i - 1][i - 1] = 1.0;
 345
 346       for (j = 1; j <= l; j++)
 347       {
 348         value[j - 1][i - 1] = 0.0;
 349         value[i - 1][j - 1] = 0.0;
 350       }
 351     }
 352   }
 353
 354   /**
 355    * DOCUMENT ME!
 356    */
 357   public void tqli() throws Exception
 358   {
 359     int n = rows;
 360
 361     int m;
 362     int l;
 363     int iter;
 364     int i;
 365     int k;
 366     double s;
 367     double r;
 368     double p;
 369     ;
 370
 371     double g;
 372     double f;
 373     double dd;
 374     double c;
 375     double b;
 376
 377     for (i = 2; i <= n; i++)
 378     {
 379       e[i - 2] = e[i - 1];
 380     }
 381
 382     e[n - 1] = 0.0;
 383
 384     for (l = 1; l <= n; l++)
 385     {
 386       iter = 0;
 387
 388       do
 389       {
 390         for (m = l; m <= (n - 1); m++)
 391         {
 392           dd = Math.abs(d[m - 1]) + Math.abs(d[m]);
 393
 394           if ((Math.abs(e[m - 1]) + dd) == dd)
 395           {
 396             break;
 397           }
 398         }
 399
 400         if (m != l)
 401         {
 402           iter++;
 403
 404           if (iter == maxIter)
 405           {
 406             throw new Exception(MessageManager.formatMessage("exception.matrix_too_many_iteration", new String[]{"tqli", Integer.valueOf(maxIter).toString()}));
 407           }
 408           else
 409           {
 410             // System.out.println("Iteration " + iter);
 411           }
 412
 413           g = (d[l] - d[l - 1]) / (2.0 * e[l - 1]);
 414           r = Math.sqrt((g * g) + 1.0);
 415           g = d[m - 1] - d[l - 1] + (e[l - 1] / (g + sign(r, g)));
 416           c = 1.0;
 417           s = c;
 418           p = 0.0;
 419
 420           for (i = m - 1; i >= l; i--)
 421           {
 422             f = s * e[i - 1];
 423             b = c * e[i - 1];
 424
 425             if (Math.abs(f) >= Math.abs(g))
 426             {
 427               c = g / f;
 428               r = Math.sqrt((c * c) + 1.0);
 429               e[i] = f * r;
 430               s = 1.0 / r;
 431               c *= s;
 432             }
 433             else
 434             {
 435               s = f / g;
 436               r = Math.sqrt((s * s) + 1.0);
 437               e[i] = g * r;
 438               c = 1.0 / r;
 439               s *= c;
 440             }
 441
 442             g = d[i] - p;
 443             r = ((d[i - 1] - g) * s) + (2.0 * c * b);
 444             p = s * r;
 445             d[i] = g + p;
 446             g = (c * r) - b;
 447
 448             for (k = 1; k <= n; k++)
 449             {
 450               f = value[k - 1][i];
 451               value[k - 1][i] = (s * value[k - 1][i - 1]) + (c * f);
 452               value[k - 1][i - 1] = (c * value[k - 1][i - 1]) - (s * f);
 453             }
 454           }
 455
 456           d[l - 1] = d[l - 1] - p;
 457           e[l - 1] = g;
 458           e[m - 1] = 0.0;
 459         }
 460       } while (m != l);
 461     }
 462   }
 463
 464   /**
 465    * DOCUMENT ME!
 466    */
 467   public void tred2()
 468   {
 469     int n = rows;
 470     int l;
 471     int k;
 472     int j;
 473     int i;
 474
 475     double scale;
 476     double hh;
 477     double h;
 478     double g;
 479     double f;
 480
 481     this.d = new double[rows];
 482     this.e = new double[rows];
 483
 484     for (i = n - 1; i >= 1; i--)
 485     {
 486       l = i - 1;
 487       h = 0.0;
 488       scale = 0.0;
 489
 490       if (l > 0)
 491       {
 492         for (k = 0; k < l; k++)
 493         {
 494           scale += Math.abs(value[i][k]);
 495         }
 496
 497         if (scale == 0.0)
 498         {
 499           e[i] = value[i][l];
 500         }
 501         else
 502         {
 503           for (k = 0; k < l; k++)
 504           {
 505             value[i][k] /= scale;
 506             h += (value[i][k] * value[i][k]);
 507           }
 508
 509           f = value[i][l];
 510
 511           if (f > 0)
 512           {
 513             g = -1.0 * Math.sqrt(h);
 514           }
 515           else
 516           {
 517             g = Math.sqrt(h);
 518           }
 519
 520           e[i] = scale * g;
 521           h -= (f * g);
 522           value[i][l] = f - g;
 523           f = 0.0;
 524
 525           for (j = 0; j < l; j++)
 526           {
 527             value[j][i] = value[i][j] / h;
 528             g = 0.0;
 529
 530             for (k = 0; k < j; k++)
 531             {
 532               g += (value[j][k] * value[i][k]);
 533             }
 534
 535             for (k = j; k < l; k++)
 536             {
 537               g += (value[k][j] * value[i][k]);
 538             }
 539
 540             e[j] = g / h;
 541             f += (e[j] * value[i][j]);
 542           }
 543
 544           hh = f / (h + h);
 545
 546           for (j = 0; j < l; j++)
 547           {
 548             f = value[i][j];
 549             g = e[j] - (hh * f);
 550             e[j] = g;
 551
 552             for (k = 0; k < j; k++)
 553             {
 554               value[j][k] -= ((f * e[k]) + (g * value[i][k]));
 555             }
 556           }
 557         }
 558       }
 559       else
 560       {
 561         e[i] = value[i][l];
 562       }
 563
 564       d[i] = h;
 565     }
 566
 567     d[0] = 0.0;
 568     e[0] = 0.0;
 569
 570     for (i = 0; i < n; i++)
 571     {
 572       l = i - 1;
 573
 574       if (d[i] != 0.0)
 575       {
 576         for (j = 0; j < l; j++)
 577         {
 578           g = 0.0;
 579
 580           for (k = 0; k < l; k++)
 581           {
 582             g += (value[i][k] * value[k][j]);
 583           }
 584
 585           for (k = 0; k < l; k++)
 586           {
 587             value[k][j] -= (g * value[k][i]);
 588           }
 589         }
 590       }
 591
 592       d[i] = value[i][i];
 593       value[i][i] = 1.0;
 594
 595       for (j = 0; j < l; j++)
 596       {
 597         value[j][i] = 0.0;
 598         value[i][j] = 0.0;
 599       }
 600     }
 601   }
 602
 603   /**
 604    * DOCUMENT ME!
 605    */
 606   public void tqli2() throws Exception
 607   {
 608     int n = rows;
 609
 610     int m;
 611     int l;
 612     int iter;
 613     int i;
 614     int k;
 615     double s;
 616     double r;
 617     double p;
 618     ;
 619
 620     double g;
 621     double f;
 622     double dd;
 623     double c;
 624     double b;
 625
 626     for (i = 2; i <= n; i++)
 627     {
 628       e[i - 2] = e[i - 1];
 629     }
 630
 631     e[n - 1] = 0.0;
 632
 633     for (l = 1; l <= n; l++)
 634     {
 635       iter = 0;
 636
 637       do
 638       {
 639         for (m = l; m <= (n - 1); m++)
 640         {
 641           dd = Math.abs(d[m - 1]) + Math.abs(d[m]);
 642
 643           if ((Math.abs(e[m - 1]) + dd) == dd)
 644           {
 645             break;
 646           }
 647         }
 648
 649         if (m != l)
 650         {
 651           iter++;
 652
 653           if (iter == maxIter)
 654           {
 655               throw new Exception(MessageManager.formatMessage("exception.matrix_too_many_iteration", new String[]{"tqli2", Integer.valueOf(maxIter).toString()}));
 656           }
 657           else
 658           {
 659             // System.out.println("Iteration " + iter);
 660           }
 661
 662           g = (d[l] - d[l - 1]) / (2.0 * e[l - 1]);
 663           r = Math.sqrt((g * g) + 1.0);
 664           g = d[m - 1] - d[l - 1] + (e[l - 1] / (g + sign(r, g)));
 665           c = 1.0;
 666           s = c;
 667           p = 0.0;
 668
 669           for (i = m - 1; i >= l; i--)
 670           {
 671             f = s * e[i - 1];
 672             b = c * e[i - 1];
 673
 674             if (Math.abs(f) >= Math.abs(g))
 675             {
 676               c = g / f;
 677               r = Math.sqrt((c * c) + 1.0);
 678               e[i] = f * r;
 679               s = 1.0 / r;
 680               c *= s;
 681             }
 682             else
 683             {
 684               s = f / g;
 685               r = Math.sqrt((s * s) + 1.0);
 686               e[i] = g * r;
 687               c = 1.0 / r;
 688               s *= c;
 689             }
 690
 691             g = d[i] - p;
 692             r = ((d[i - 1] - g) * s) + (2.0 * c * b);
 693             p = s * r;
 694             d[i] = g + p;
 695             g = (c * r) - b;
 696
 697             for (k = 1; k <= n; k++)
 698             {
 699               f = value[k - 1][i];
 700               value[k - 1][i] = (s * value[k - 1][i - 1]) + (c * f);
 701               value[k - 1][i - 1] = (c * value[k - 1][i - 1]) - (s * f);
 702             }
 703           }
 704
 705           d[l - 1] = d[l - 1] - p;
 706           e[l - 1] = g;
 707           e[m - 1] = 0.0;
 708         }
 709       } while (m != l);
 710     }
 711   }
 712
 713   /**
 714    * DOCUMENT ME!
 715    *
 716    * @param a
 717    *          DOCUMENT ME!
 718    * @param b
 719    *          DOCUMENT ME!
 720    *
 721    * @return DOCUMENT ME!
 722    */
 723   public double sign(double a, double b)
 724   {
 725     if (b < 0)
 726     {
 727       return -Math.abs(a);
 728     }
 729     else
 730     {
 731       return Math.abs(a);
 732     }
 733   }
 734
 735   /**
 736    * DOCUMENT ME!
 737    *
 738    * @param n
 739    *          DOCUMENT ME!
 740    *
 741    * @return DOCUMENT ME!
 742    */
 743   public double[] getColumn(int n)
 744   {
 745     double[] out = new double[rows];
 746
 747     for (int i = 0; i < rows; i++)
 748     {
 749       out[i] = value[i][n];
 750     }
 751
 752     return out;
 753   }
 754
 755   /**
 756    * DOCUMENT ME!
 757    *
 758    * @param ps
 759    *          DOCUMENT ME!
 760    */
 761   public void printD(PrintStream ps)
 762   {
 763     for (int j = 0; j < rows; j++)
 764     {
 765       Format.print(ps, "%15.4e", d[j]);
 766     }
 767   }
 768
 769   /**
 770    * DOCUMENT ME!
 771    *
 772    * @param ps
 773    *          DOCUMENT ME!
 774    */
 775   public void printE(PrintStream ps)
 776   {
 777     for (int j = 0; j < rows; j++)
 778     {
 779       Format.print(ps, "%15.4e", e[j]);
 780     }
 781   }
 782
 783   /**
 784    * DOCUMENT ME!
 785    *
 786    * @param args
 787    *          DOCUMENT ME!
 788    */
 789   public static void main(String[] args) throws Exception
 790   {
 791     int n = Integer.parseInt(args[0]);
 792     double[][] in = new double[n][n];
 793
 794     for (int i = 0; i < n; i++)
 795     {
 796       for (int j = 0; j < n; j++)
 797       {
 798         in[i][j] = (double) Math.random();
 799       }
 800     }
 801
 802     Matrix origmat = new Matrix(in, n, n);
 803
 804     // System.out.println(" --- Original matrix ---- ");
 805     // / origmat.print(System.out);
 806     // System.out.println();
 807     // System.out.println(" --- transpose matrix ---- ");
 808     Matrix trans = origmat.transpose();
 809
 810     // trans.print(System.out);
 811     // System.out.println();
 812     // System.out.println(" --- OrigT * Orig ---- ");
 813     Matrix symm = trans.postMultiply(origmat);
 814
 815     // symm.print(System.out);
 816     // System.out.println();
 817     // Copy the symmetric matrix for later
 818     // Matrix origsymm = symm.copy();
 819
 820     // This produces the tridiagonal transformation matrix
 821     // long tstart = System.currentTimeMillis();
 822     symm.tred();
 823
 824     // long tend = System.currentTimeMillis();
 825
 826     // System.out.println("Time take for tred = " + (tend-tstart) + "ms");
 827     // System.out.println(" ---Tridiag transform matrix ---");
 828     // symm.print(System.out);
 829     // System.out.println();
 830     // System.out.println(" --- D vector ---");
 831     // symm.printD(System.out);
 832     // System.out.println();
 833     // System.out.println(" --- E vector ---");
 834     // symm.printE(System.out);
 835     // System.out.println();
 836     // Now produce the diagonalization matrix
 837     // tstart = System.currentTimeMillis();
 838     symm.tqli();
 839     // tend = System.currentTimeMillis();
 840
 841     // System.out.println("Time take for tqli = " + (tend-tstart) + " ms");
 842     // System.out.println(" --- New diagonalization matrix ---");
 843     // symm.print(System.out);
 844     // System.out.println();
 845     // System.out.println(" --- D vector ---");
 846     // symm.printD(System.out);
 847     // System.out.println();
 848     // System.out.println(" --- E vector ---");
 849     // symm.printE(System.out);
 850     // System.out.println();
 851     // System.out.println(" --- First eigenvector --- ");
 852     // double[] eigenv = symm.getColumn(0);
 853     // for (int i=0; i < eigenv.length;i++) {
 854     // Format.print(System.out,"%15.4f",eigenv[i]);
 855     // }
 856     // System.out.println();
 857     // double[] neigenv = origsymm.vectorPostMultiply(eigenv);
 858     // for (int i=0; i < neigenv.length;i++) {
 859     // Format.print(System.out,"%15.4f",neigenv[i]/symm.d[0]);
 860     // }
 861     // System.out.println();
 862   }
 863 }