src/jalview/math/Matrix.java

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