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("Too many iterations in tqli (" + maxIter
 407                     + ")");
 408           }
 409           else
 410           {
 411             // System.out.println("Iteration " + iter);
 412           }
 413
 414           g = (d[l] - d[l - 1]) / (2.0 * e[l - 1]);
 415           r = Math.sqrt((g * g) + 1.0);
 416           g = d[m - 1] - d[l - 1] + (e[l - 1] / (g + sign(r, g)));
 417           c = 1.0;
 418           s = c;
 419           p = 0.0;
 420
 421           for (i = m - 1; i >= l; i--)
 422           {
 423             f = s * e[i - 1];
 424             b = c * e[i - 1];
 425
 426             if (Math.abs(f) >= Math.abs(g))
 427             {
 428               c = g / f;
 429               r = Math.sqrt((c * c) + 1.0);
 430               e[i] = f * r;
 431               s = 1.0 / r;
 432               c *= s;
 433             }
 434             else
 435             {
 436               s = f / g;
 437               r = Math.sqrt((s * s) + 1.0);
 438               e[i] = g * r;
 439               c = 1.0 / r;
 440               s *= c;
 441             }
 442
 443             g = d[i] - p;
 444             r = ((d[i - 1] - g) * s) + (2.0 * c * b);
 445             p = s * r;
 446             d[i] = g + p;
 447             g = (c * r) - b;
 448
 449             for (k = 1; k <= n; k++)
 450             {
 451               f = value[k - 1][i];
 452               value[k - 1][i] = (s * value[k - 1][i - 1]) + (c * f);
 453               value[k - 1][i - 1] = (c * value[k - 1][i - 1]) - (s * f);
 454             }
 455           }
 456
 457           d[l - 1] = d[l - 1] - p;
 458           e[l - 1] = g;
 459           e[m - 1] = 0.0;
 460         }
 461       } while (m != l);
 462     }
 463   }
 464
 465   /**
 466    * DOCUMENT ME!
 467    */
 468   public void tred2()
 469   {
 470     int n = rows;
 471     int l;
 472     int k;
 473     int j;
 474     int i;
 475
 476     double scale;
 477     double hh;
 478     double h;
 479     double g;
 480     double f;
 481
 482     this.d = new double[rows];
 483     this.e = new double[rows];
 484
 485     for (i = n - 1; i >= 1; i--)
 486     {
 487       l = i - 1;
 488       h = 0.0;
 489       scale = 0.0;
 490
 491       if (l > 0)
 492       {
 493         for (k = 0; k < l; k++)
 494         {
 495           scale += Math.abs(value[i][k]);
 496         }
 497
 498         if (scale == 0.0)
 499         {
 500           e[i] = value[i][l];
 501         }
 502         else
 503         {
 504           for (k = 0; k < l; k++)
 505           {
 506             value[i][k] /= scale;
 507             h += (value[i][k] * value[i][k]);
 508           }
 509
 510           f = value[i][l];
 511
 512           if (f > 0)
 513           {
 514             g = -1.0 * Math.sqrt(h);
 515           }
 516           else
 517           {
 518             g = Math.sqrt(h);
 519           }
 520
 521           e[i] = scale * g;
 522           h -= (f * g);
 523           value[i][l] = f - g;
 524           f = 0.0;
 525
 526           for (j = 0; j < l; j++)
 527           {
 528             value[j][i] = value[i][j] / h;
 529             g = 0.0;
 530
 531             for (k = 0; k < j; k++)
 532             {
 533               g += (value[j][k] * value[i][k]);
 534             }
 535
 536             for (k = j; k < l; k++)
 537             {
 538               g += (value[k][j] * value[i][k]);
 539             }
 540
 541             e[j] = g / h;
 542             f += (e[j] * value[i][j]);
 543           }
 544
 545           hh = f / (h + h);
 546
 547           for (j = 0; j < l; j++)
 548           {
 549             f = value[i][j];
 550             g = e[j] - (hh * f);
 551             e[j] = g;
 552
 553             for (k = 0; k < j; k++)
 554             {
 555               value[j][k] -= ((f * e[k]) + (g * value[i][k]));
 556             }
 557           }
 558         }
 559       }
 560       else
 561       {
 562         e[i] = value[i][l];
 563       }
 564
 565       d[i] = h;
 566     }
 567
 568     d[0] = 0.0;
 569     e[0] = 0.0;
 570
 571     for (i = 0; i < n; i++)
 572     {
 573       l = i - 1;
 574
 575       if (d[i] != 0.0)
 576       {
 577         for (j = 0; j < l; j++)
 578         {
 579           g = 0.0;
 580
 581           for (k = 0; k < l; k++)
 582           {
 583             g += (value[i][k] * value[k][j]);
 584           }
 585
 586           for (k = 0; k < l; k++)
 587           {
 588             value[k][j] -= (g * value[k][i]);
 589           }
 590         }
 591       }
 592
 593       d[i] = value[i][i];
 594       value[i][i] = 1.0;
 595
 596       for (j = 0; j < l; j++)
 597       {
 598         value[j][i] = 0.0;
 599         value[i][j] = 0.0;
 600       }
 601     }
 602   }
 603
 604   /**
 605    * DOCUMENT ME!
 606    */
 607   public void tqli2() throws Exception
 608   {
 609     int n = rows;
 610
 611     int m;
 612     int l;
 613     int iter;
 614     int i;
 615     int k;
 616     double s;
 617     double r;
 618     double p;
 619     ;
 620
 621     double g;
 622     double f;
 623     double dd;
 624     double c;
 625     double b;
 626
 627     for (i = 2; i <= n; i++)
 628     {
 629       e[i - 2] = e[i - 1];
 630     }
 631
 632     e[n - 1] = 0.0;
 633
 634     for (l = 1; l <= n; l++)
 635     {
 636       iter = 0;
 637
 638       do
 639       {
 640         for (m = l; m <= (n - 1); m++)
 641         {
 642           dd = Math.abs(d[m - 1]) + Math.abs(d[m]);
 643
 644           if ((Math.abs(e[m - 1]) + dd) == dd)
 645           {
 646             break;
 647           }
 648         }
 649
 650         if (m != l)
 651         {
 652           iter++;
 653
 654           if (iter == maxIter)
 655           {
 656             throw new Exception("Too many iterations in tqli2 (max is "
 657                     + maxIter + ")");
 658           }
 659           else
 660           {
 661             // System.out.println("Iteration " + iter);
 662           }
 663
 664           g = (d[l] - d[l - 1]) / (2.0 * e[l - 1]);
 665           r = Math.sqrt((g * g) + 1.0);
 666           g = d[m - 1] - d[l - 1] + (e[l - 1] / (g + sign(r, g)));
 667           c = 1.0;
 668           s = c;
 669           p = 0.0;
 670
 671           for (i = m - 1; i >= l; i--)
 672           {
 673             f = s * e[i - 1];
 674             b = c * e[i - 1];
 675
 676             if (Math.abs(f) >= Math.abs(g))
 677             {
 678               c = g / f;
 679               r = Math.sqrt((c * c) + 1.0);
 680               e[i] = f * r;
 681               s = 1.0 / r;
 682               c *= s;
 683             }
 684             else
 685             {
 686               s = f / g;
 687               r = Math.sqrt((s * s) + 1.0);
 688               e[i] = g * r;
 689               c = 1.0 / r;
 690               s *= c;
 691             }
 692
 693             g = d[i] - p;
 694             r = ((d[i - 1] - g) * s) + (2.0 * c * b);
 695             p = s * r;
 696             d[i] = g + p;
 697             g = (c * r) - b;
 698
 699             for (k = 1; k <= n; k++)
 700             {
 701               f = value[k - 1][i];
 702               value[k - 1][i] = (s * value[k - 1][i - 1]) + (c * f);
 703               value[k - 1][i - 1] = (c * value[k - 1][i - 1]) - (s * f);
 704             }
 705           }
 706
 707           d[l - 1] = d[l - 1] - p;
 708           e[l - 1] = g;
 709           e[m - 1] = 0.0;
 710         }
 711       } while (m != l);
 712     }
 713   }
 714
 715   /**
 716    * DOCUMENT ME!
 717    *
 718    * @param a
 719    *          DOCUMENT ME!
 720    * @param b
 721    *          DOCUMENT ME!
 722    *
 723    * @return DOCUMENT ME!
 724    */
 725   public double sign(double a, double b)
 726   {
 727     if (b < 0)
 728     {
 729       return -Math.abs(a);
 730     }
 731     else
 732     {
 733       return Math.abs(a);
 734     }
 735   }
 736
 737   /**
 738    * DOCUMENT ME!
 739    *
 740    * @param n
 741    *          DOCUMENT ME!
 742    *
 743    * @return DOCUMENT ME!
 744    */
 745   public double[] getColumn(int n)
 746   {
 747     double[] out = new double[rows];
 748
 749     for (int i = 0; i < rows; i++)
 750     {
 751       out[i] = value[i][n];
 752     }
 753
 754     return out;
 755   }
 756
 757   /**
 758    * DOCUMENT ME!
 759    *
 760    * @param ps
 761    *          DOCUMENT ME!
 762    */
 763   public void printD(PrintStream ps)
 764   {
 765     for (int j = 0; j < rows; j++)
 766     {
 767       Format.print(ps, "%15.4e", d[j]);
 768     }
 769   }
 770
 771   /**
 772    * DOCUMENT ME!
 773    *
 774    * @param ps
 775    *          DOCUMENT ME!
 776    */
 777   public void printE(PrintStream ps)
 778   {
 779     for (int j = 0; j < rows; j++)
 780     {
 781       Format.print(ps, "%15.4e", e[j]);
 782     }
 783   }
 784
 785   /**
 786    * DOCUMENT ME!
 787    *
 788    * @param args
 789    *          DOCUMENT ME!
 790    */
 791   public static void main(String[] args) throws Exception
 792   {
 793     int n = Integer.parseInt(args[0]);
 794     double[][] in = new double[n][n];
 795
 796     for (int i = 0; i < n; i++)
 797     {
 798       for (int j = 0; j < n; j++)
 799       {
 800         in[i][j] = (double) Math.random();
 801       }
 802     }
 803
 804     Matrix origmat = new Matrix(in, n, n);
 805
 806     // System.out.println(" --- Original matrix ---- ");
 807     // / origmat.print(System.out);
 808     // System.out.println();
 809     // System.out.println(" --- transpose matrix ---- ");
 810     Matrix trans = origmat.transpose();
 811
 812     // trans.print(System.out);
 813     // System.out.println();
 814     // System.out.println(" --- OrigT * Orig ---- ");
 815     Matrix symm = trans.postMultiply(origmat);
 816
 817     // symm.print(System.out);
 818     // System.out.println();
 819     // Copy the symmetric matrix for later
 820     // Matrix origsymm = symm.copy();
 821
 822     // This produces the tridiagonal transformation matrix
 823     // long tstart = System.currentTimeMillis();
 824     symm.tred();
 825
 826     // long tend = System.currentTimeMillis();
 827
 828     // System.out.println("Time take for tred = " + (tend-tstart) + "ms");
 829     // System.out.println(" ---Tridiag transform matrix ---");
 830     // symm.print(System.out);
 831     // System.out.println();
 832     // System.out.println(" --- D vector ---");
 833     // symm.printD(System.out);
 834     // System.out.println();
 835     // System.out.println(" --- E vector ---");
 836     // symm.printE(System.out);
 837     // System.out.println();
 838     // Now produce the diagonalization matrix
 839     // tstart = System.currentTimeMillis();
 840     symm.tqli();
 841     // tend = System.currentTimeMillis();
 842
 843     // System.out.println("Time take for tqli = " + (tend-tstart) + " ms");
 844     // System.out.println(" --- New diagonalization matrix ---");
 845     // symm.print(System.out);
 846     // System.out.println();
 847     // System.out.println(" --- D vector ---");
 848     // symm.printD(System.out);
 849     // System.out.println();
 850     // System.out.println(" --- E vector ---");
 851     // symm.printE(System.out);
 852     // System.out.println();
 853     // System.out.println(" --- First eigenvector --- ");
 854     // double[] eigenv = symm.getColumn(0);
 855     // for (int i=0; i < eigenv.length;i++) {
 856     // Format.print(System.out,"%15.4f",eigenv[i]);
 857     // }
 858     // System.out.println();
 859     // double[] neigenv = origsymm.vectorPostMultiply(eigenv);
 860     // for (int i=0; i < neigenv.length;i++) {
 861     // Format.print(System.out,"%15.4f",neigenv[i]/symm.d[0]);
 862     // }
 863     // System.out.println();
 864   }
 865 }