src/jalview/math/Matrix.java

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