src/jalview/math/Matrix.java

   1 /*\r
   2 * Jalview - A Sequence Alignment Editor and Viewer\r
   3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4 *\r
   5 * This program is free software; you can redistribute it and/or\r
   6 * modify it under the terms of the GNU General Public License\r
   7 * as published by the Free Software Foundation; either version 2\r
   8 * of the License, or (at your option) any later version.\r
   9 *\r
  10 * This program is distributed in the hope that it will be useful,\r
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 * GNU General Public License for more details.\r
  14 *\r
  15 * You should have received a copy of the GNU General Public License\r
  16 * along with this program; if not, write to the Free Software\r
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18 */\r
  19 package jalview.math;\r
  20 \r
  21 import jalview.util.*;\r
  22 \r
  23 import java.io.*;\r
  24 \r
  25 \r
  26 public class Matrix {\r
  27     /**\r
  28      * SMJSPUBLIC\r
  29      */\r
  30     public double[][] value;\r
  31     public int rows;\r
  32     public int cols;\r
  33     public double[] d; // Diagonal\r
  34     public double[] e; // off diagonal\r
  35 \r
  36     public Matrix(double[][] value, int rows, int cols) {\r
  37         this.rows = rows;\r
  38         this.cols = cols;\r
  39         this.value = value;\r
  40     }\r
  41 \r
  42     public Matrix transpose() {\r
  43         double[][] out = new double[cols][rows];\r
  44 \r
  45         for (int i = 0; i < cols; i++) {\r
  46             for (int j = 0; j < rows; j++) {\r
  47                 out[i][j] = value[j][i];\r
  48             }\r
  49         }\r
  50 \r
  51         return new Matrix(out, cols, rows);\r
  52     }\r
  53 \r
  54     public void print(PrintStream ps) {\r
  55         for (int i = 0; i < rows; i++) {\r
  56             for (int j = 0; j < cols; j++) {\r
  57                 Format.print(ps, "%8.2f", value[i][j]);\r
  58             }\r
  59 \r
  60             ps.println();\r
  61         }\r
  62     }\r
  63 \r
  64     public Matrix preMultiply(Matrix in) {\r
  65         double[][] tmp = new double[in.rows][this.cols];\r
  66 \r
  67         for (int i = 0; i < in.rows; i++) {\r
  68             for (int j = 0; j < this.cols; j++) {\r
  69                 tmp[i][j] = 0.0;\r
  70 \r
  71                 for (int k = 0; k < in.cols; k++) {\r
  72                     tmp[i][j] += (in.value[i][k] * this.value[k][j]);\r
  73                 }\r
  74             }\r
  75         }\r
  76 \r
  77         return new Matrix(tmp, in.rows, this.cols);\r
  78     }\r
  79 \r
  80     public double[] vectorPostMultiply(double[] in) {\r
  81         double[] out = new double[in.length];\r
  82 \r
  83         for (int i = 0; i < in.length; i++) {\r
  84             out[i] = 0.0;\r
  85 \r
  86             for (int k = 0; k < in.length; k++) {\r
  87                 out[i] += (value[i][k] * in[k]);\r
  88             }\r
  89         }\r
  90 \r
  91         return out;\r
  92     }\r
  93 \r
  94     public Matrix postMultiply(Matrix in) {\r
  95         double[][] out = new double[this.rows][in.cols];\r
  96 \r
  97         for (int i = 0; i < this.rows; i++) {\r
  98             for (int j = 0; j < in.cols; j++) {\r
  99                 out[i][j] = 0.0;\r
 100 \r
 101                 for (int k = 0; k < rows; k++) {\r
 102                     out[i][j] = out[i][j] + (value[i][k] * in.value[k][j]);\r
 103                 }\r
 104             }\r
 105         }\r
 106 \r
 107         return new Matrix(out, this.cols, in.rows);\r
 108     }\r
 109 \r
 110     public Matrix copy() {\r
 111         double[][] newmat = new double[rows][cols];\r
 112 \r
 113         for (int i = 0; i < rows; i++) {\r
 114             for (int j = 0; j < cols; j++) {\r
 115                 newmat[i][j] = value[i][j];\r
 116             }\r
 117         }\r
 118 \r
 119         return new Matrix(newmat, rows, cols);\r
 120     }\r
 121 \r
 122     public void tred() {\r
 123         int n = rows;\r
 124         int l;\r
 125         int k;\r
 126         int j;\r
 127         int i;\r
 128 \r
 129         double scale;\r
 130         double hh;\r
 131         double h;\r
 132         double g;\r
 133         double f;\r
 134 \r
 135         this.d = new double[rows];\r
 136         this.e = new double[rows];\r
 137 \r
 138         for (i = n; i >= 2; i--) {\r
 139             l = i - 1;\r
 140             h = 0.0;\r
 141             scale = 0.0;\r
 142 \r
 143             if (l > 1) {\r
 144                 for (k = 1; k <= l; k++) {\r
 145                     scale += Math.abs(value[i - 1][k - 1]);\r
 146                 }\r
 147 \r
 148                 if (scale == 0.0) {\r
 149                     e[i - 1] = value[i - 1][l - 1];\r
 150                 } else {\r
 151                     for (k = 1; k <= l; k++) {\r
 152                         value[i - 1][k - 1] /= scale;\r
 153                         h += (value[i - 1][k - 1] * value[i - 1][k - 1]);\r
 154                     }\r
 155 \r
 156                     f = value[i - 1][l - 1];\r
 157 \r
 158                     if (f > 0) {\r
 159                         g = -1.0 * Math.sqrt(h);\r
 160                     } else {\r
 161                         g = Math.sqrt(h);\r
 162                     }\r
 163 \r
 164                     e[i - 1] = scale * g;\r
 165                     h -= (f * g);\r
 166                     value[i - 1][l - 1] = f - g;\r
 167                     f = 0.0;\r
 168 \r
 169                     for (j = 1; j <= l; j++) {\r
 170                         value[j - 1][i - 1] = value[i - 1][j - 1] / h;\r
 171                         g = 0.0;\r
 172 \r
 173                         for (k = 1; k <= j; k++) {\r
 174                             g += (value[j - 1][k - 1] * value[i - 1][k - 1]);\r
 175                         }\r
 176 \r
 177                         for (k = j + 1; k <= l; k++) {\r
 178                             g += (value[k - 1][j - 1] * value[i - 1][k - 1]);\r
 179                         }\r
 180 \r
 181                         e[j - 1] = g / h;\r
 182                         f += (e[j - 1] * value[i - 1][j - 1]);\r
 183                     }\r
 184 \r
 185                     hh = f / (h + h);\r
 186 \r
 187                     for (j = 1; j <= l; j++) {\r
 188                         f = value[i - 1][j - 1];\r
 189                         g = e[j - 1] - (hh * f);\r
 190                         e[j - 1] = g;\r
 191 \r
 192                         for (k = 1; k <= j; k++) {\r
 193                             value[j - 1][k - 1] -= ((f * e[k - 1]) +\r
 194                             (g * value[i - 1][k - 1]));\r
 195                         }\r
 196                     }\r
 197                 }\r
 198             } else {\r
 199                 e[i - 1] = value[i - 1][l - 1];\r
 200             }\r
 201 \r
 202             d[i - 1] = h;\r
 203         }\r
 204 \r
 205         d[0] = 0.0;\r
 206         e[0] = 0.0;\r
 207 \r
 208         for (i = 1; i <= n; i++) {\r
 209             l = i - 1;\r
 210 \r
 211             if (d[i - 1] != 0.0) {\r
 212                 for (j = 1; j <= l; j++) {\r
 213                     g = 0.0;\r
 214 \r
 215                     for (k = 1; k <= l; k++) {\r
 216                         g += (value[i - 1][k - 1] * value[k - 1][j - 1]);\r
 217                     }\r
 218 \r
 219                     for (k = 1; k <= l; k++) {\r
 220                         value[k - 1][j - 1] -= (g * value[k - 1][i - 1]);\r
 221                     }\r
 222                 }\r
 223             }\r
 224 \r
 225             d[i - 1] = value[i - 1][i - 1];\r
 226             value[i - 1][i - 1] = 1.0;\r
 227 \r
 228             for (j = 1; j <= l; j++) {\r
 229                 value[j - 1][i - 1] = 0.0;\r
 230                 value[i - 1][j - 1] = 0.0;\r
 231             }\r
 232         }\r
 233     }\r
 234 \r
 235     public void tqli() {\r
 236         int n = rows;\r
 237 \r
 238         int m;\r
 239         int l;\r
 240         int iter;\r
 241         int i;\r
 242         int k;\r
 243         double s;\r
 244         double r;\r
 245         double p;\r
 246         ;\r
 247 \r
 248         double g;\r
 249         double f;\r
 250         double dd;\r
 251         double c;\r
 252         double b;\r
 253 \r
 254         for (i = 2; i <= n; i++) {\r
 255             e[i - 2] = e[i - 1];\r
 256         }\r
 257 \r
 258         e[n - 1] = 0.0;\r
 259 \r
 260         for (l = 1; l <= n; l++) {\r
 261             iter = 0;\r
 262 \r
 263             do {\r
 264                 for (m = l; m <= (n - 1); m++) {\r
 265                     dd = Math.abs(d[m - 1]) + Math.abs(d[m]);\r
 266 \r
 267                     if ((Math.abs(e[m - 1]) + dd) == dd) {\r
 268                         break;\r
 269                     }\r
 270                 }\r
 271 \r
 272                 if (m != l) {\r
 273                     iter++;\r
 274 \r
 275                     if (iter == 30) {\r
 276                         System.err.print("Too many iterations in tqli");\r
 277                         System.exit(0); // JBPNote - should this really be here ???\r
 278                     } else {\r
 279                         //          System.out.println("Iteration " + iter);\r
 280                     }\r
 281 \r
 282                     g = (d[l] - d[l - 1]) / (2.0 * e[l - 1]);\r
 283                     r = Math.sqrt((g * g) + 1.0);\r
 284                     g = d[m - 1] - d[l - 1] + (e[l - 1] / (g + sign(r, g)));\r
 285                     c = 1.0;\r
 286                     s = c;\r
 287                     p = 0.0;\r
 288 \r
 289                     for (i = m - 1; i >= l; i--) {\r
 290                         f = s * e[i - 1];\r
 291                         b = c * e[i - 1];\r
 292 \r
 293                         if (Math.abs(f) >= Math.abs(g)) {\r
 294                             c = g / f;\r
 295                             r = Math.sqrt((c * c) + 1.0);\r
 296                             e[i] = f * r;\r
 297                             s = 1.0 / r;\r
 298                             c *= s;\r
 299                         } else {\r
 300                             s = f / g;\r
 301                             r = Math.sqrt((s * s) + 1.0);\r
 302                             e[i] = g * r;\r
 303                             c = 1.0 / r;\r
 304                             s *= c;\r
 305                         }\r
 306 \r
 307                         g = d[i] - p;\r
 308                         r = ((d[i - 1] - g) * s) + (2.0 * c * b);\r
 309                         p = s * r;\r
 310                         d[i] = g + p;\r
 311                         g = (c * r) - b;\r
 312 \r
 313                         for (k = 1; k <= n; k++) {\r
 314                             f = value[k - 1][i];\r
 315                             value[k - 1][i] = (s * value[k - 1][i - 1]) +\r
 316                                 (c * f);\r
 317                             value[k - 1][i - 1] = (c * value[k - 1][i - 1]) -\r
 318                                 (s * f);\r
 319                         }\r
 320                     }\r
 321 \r
 322                     d[l - 1] = d[l - 1] - p;\r
 323                     e[l - 1] = g;\r
 324                     e[m - 1] = 0.0;\r
 325                 }\r
 326             } while (m != l);\r
 327         }\r
 328     }\r
 329 \r
 330     public void tred2() {\r
 331         int n = rows;\r
 332         int l;\r
 333         int k;\r
 334         int j;\r
 335         int i;\r
 336 \r
 337         double scale;\r
 338         double hh;\r
 339         double h;\r
 340         double g;\r
 341         double f;\r
 342 \r
 343         this.d = new double[rows];\r
 344         this.e = new double[rows];\r
 345 \r
 346         for (i = n - 1; i >= 1; i--) {\r
 347             l = i - 1;\r
 348             h = 0.0;\r
 349             scale = 0.0;\r
 350 \r
 351             if (l > 0) {\r
 352                 for (k = 0; k < l; k++) {\r
 353                     scale += Math.abs(value[i][k]);\r
 354                 }\r
 355 \r
 356                 if (scale == 0.0) {\r
 357                     e[i] = value[i][l];\r
 358                 } else {\r
 359                     for (k = 0; k < l; k++) {\r
 360                         value[i][k] /= scale;\r
 361                         h += (value[i][k] * value[i][k]);\r
 362                     }\r
 363 \r
 364                     f = value[i][l];\r
 365 \r
 366                     if (f > 0) {\r
 367                         g = -1.0 * Math.sqrt(h);\r
 368                     } else {\r
 369                         g = Math.sqrt(h);\r
 370                     }\r
 371 \r
 372                     e[i] = scale * g;\r
 373                     h -= (f * g);\r
 374                     value[i][l] = f - g;\r
 375                     f = 0.0;\r
 376 \r
 377                     for (j = 0; j < l; j++) {\r
 378                         value[j][i] = value[i][j] / h;\r
 379                         g = 0.0;\r
 380 \r
 381                         for (k = 0; k < j; k++) {\r
 382                             g += (value[j][k] * value[i][k]);\r
 383                         }\r
 384 \r
 385                         for (k = j; k < l; k++) {\r
 386                             g += (value[k][j] * value[i][k]);\r
 387                         }\r
 388 \r
 389                         e[j] = g / h;\r
 390                         f += (e[j] * value[i][j]);\r
 391                     }\r
 392 \r
 393                     hh = f / (h + h);\r
 394 \r
 395                     for (j = 0; j < l; j++) {\r
 396                         f = value[i][j];\r
 397                         g = e[j] - (hh * f);\r
 398                         e[j] = g;\r
 399 \r
 400                         for (k = 0; k < j; k++) {\r
 401                             value[j][k] -= ((f * e[k]) + (g * value[i][k]));\r
 402                         }\r
 403                     }\r
 404                 }\r
 405             } else {\r
 406                 e[i] = value[i][l];\r
 407             }\r
 408 \r
 409             d[i] = h;\r
 410         }\r
 411 \r
 412         d[0] = 0.0;\r
 413         e[0] = 0.0;\r
 414 \r
 415         for (i = 0; i < n; i++) {\r
 416             l = i - 1;\r
 417 \r
 418             if (d[i] != 0.0) {\r
 419                 for (j = 0; j < l; j++) {\r
 420                     g = 0.0;\r
 421 \r
 422                     for (k = 0; k < l; k++) {\r
 423                         g += (value[i][k] * value[k][j]);\r
 424                     }\r
 425 \r
 426                     for (k = 0; k < l; k++) {\r
 427                         value[k][j] -= (g * value[k][i]);\r
 428                     }\r
 429                 }\r
 430             }\r
 431 \r
 432             d[i] = value[i][i];\r
 433             value[i][i] = 1.0;\r
 434 \r
 435             for (j = 0; j < l; j++) {\r
 436                 value[j][i] = 0.0;\r
 437                 value[i][j] = 0.0;\r
 438             }\r
 439         }\r
 440     }\r
 441 \r
 442     public void tqli2() {\r
 443         int n = rows;\r
 444 \r
 445         int m;\r
 446         int l;\r
 447         int iter;\r
 448         int i;\r
 449         int k;\r
 450         double s;\r
 451         double r;\r
 452         double p;\r
 453         ;\r
 454 \r
 455         double g;\r
 456         double f;\r
 457         double dd;\r
 458         double c;\r
 459         double b;\r
 460 \r
 461         for (i = 2; i <= n; i++) {\r
 462             e[i - 2] = e[i - 1];\r
 463         }\r
 464 \r
 465         e[n - 1] = 0.0;\r
 466 \r
 467         for (l = 1; l <= n; l++) {\r
 468             iter = 0;\r
 469 \r
 470             do {\r
 471                 for (m = l; m <= (n - 1); m++) {\r
 472                     dd = Math.abs(d[m - 1]) + Math.abs(d[m]);\r
 473 \r
 474                     if ((Math.abs(e[m - 1]) + dd) == dd) {\r
 475                         break;\r
 476                     }\r
 477                 }\r
 478 \r
 479                 if (m != l) {\r
 480                     iter++;\r
 481 \r
 482                     if (iter == 30) {\r
 483                         System.err.print("Too many iterations in tqli");\r
 484                         System.exit(0); // JBPNote - same as above - not a graceful exit!\r
 485                     } else {\r
 486                         //          System.out.println("Iteration " + iter);\r
 487                     }\r
 488 \r
 489                     g = (d[l] - d[l - 1]) / (2.0 * e[l - 1]);\r
 490                     r = Math.sqrt((g * g) + 1.0);\r
 491                     g = d[m - 1] - d[l - 1] + (e[l - 1] / (g + sign(r, g)));\r
 492                     c = 1.0;\r
 493                     s = c;\r
 494                     p = 0.0;\r
 495 \r
 496                     for (i = m - 1; i >= l; i--) {\r
 497                         f = s * e[i - 1];\r
 498                         b = c * e[i - 1];\r
 499 \r
 500                         if (Math.abs(f) >= Math.abs(g)) {\r
 501                             c = g / f;\r
 502                             r = Math.sqrt((c * c) + 1.0);\r
 503                             e[i] = f * r;\r
 504                             s = 1.0 / r;\r
 505                             c *= s;\r
 506                         } else {\r
 507                             s = f / g;\r
 508                             r = Math.sqrt((s * s) + 1.0);\r
 509                             e[i] = g * r;\r
 510                             c = 1.0 / r;\r
 511                             s *= c;\r
 512                         }\r
 513 \r
 514                         g = d[i] - p;\r
 515                         r = ((d[i - 1] - g) * s) + (2.0 * c * b);\r
 516                         p = s * r;\r
 517                         d[i] = g + p;\r
 518                         g = (c * r) - b;\r
 519 \r
 520                         for (k = 1; k <= n; k++) {\r
 521                             f = value[k - 1][i];\r
 522                             value[k - 1][i] = (s * value[k - 1][i - 1]) +\r
 523                                 (c * f);\r
 524                             value[k - 1][i - 1] = (c * value[k - 1][i - 1]) -\r
 525                                 (s * f);\r
 526                         }\r
 527                     }\r
 528 \r
 529                     d[l - 1] = d[l - 1] - p;\r
 530                     e[l - 1] = g;\r
 531                     e[m - 1] = 0.0;\r
 532                 }\r
 533             } while (m != l);\r
 534         }\r
 535     }\r
 536 \r
 537     public double sign(double a, double b) {\r
 538         if (b < 0) {\r
 539             return -Math.abs(a);\r
 540         } else {\r
 541             return Math.abs(a);\r
 542         }\r
 543     }\r
 544 \r
 545     public double[] getColumn(int n) {\r
 546         double[] out = new double[rows];\r
 547 \r
 548         for (int i = 0; i < rows; i++) {\r
 549             out[i] = value[i][n];\r
 550         }\r
 551 \r
 552         return out;\r
 553     }\r
 554 \r
 555     public void printD(PrintStream ps) {\r
 556         for (int j = 0; j < rows; j++) {\r
 557             Format.print(ps, "%15.4e", d[j]);\r
 558         }\r
 559     }\r
 560 \r
 561     public void printE(PrintStream ps) {\r
 562         for (int j = 0; j < rows; j++) {\r
 563             Format.print(ps, "%15.4e", e[j]);\r
 564         }\r
 565     }\r
 566 \r
 567     public static void main(String[] args) {\r
 568         int n = Integer.parseInt(args[0]);\r
 569         double[][] in = new double[n][n];\r
 570 \r
 571         for (int i = 0; i < n; i++) {\r
 572             for (int j = 0; j < n; j++) {\r
 573                 in[i][j] = (double) Math.random();\r
 574             }\r
 575         }\r
 576 \r
 577         Matrix origmat = new Matrix(in, n, n);\r
 578 \r
 579         //    System.out.println(" --- Original matrix ---- ");\r
 580         ///    origmat.print(System.out);\r
 581         //System.out.println();\r
 582         //System.out.println(" --- transpose matrix ---- ");\r
 583         Matrix trans = origmat.transpose();\r
 584 \r
 585         //trans.print(System.out);\r
 586         //System.out.println();\r
 587         //System.out.println(" --- OrigT * Orig ---- ");\r
 588         Matrix symm = trans.postMultiply(origmat);\r
 589 \r
 590         //symm.print(System.out);\r
 591         //System.out.println();\r
 592         // Copy the symmetric matrix for later\r
 593         Matrix origsymm = symm.copy();\r
 594 \r
 595         // This produces the tridiagonal transformation matrix\r
 596         long tstart = System.currentTimeMillis();\r
 597         symm.tred();\r
 598 \r
 599         long tend = System.currentTimeMillis();\r
 600 \r
 601         //System.out.println("Time take for tred = " + (tend-tstart) + "ms");\r
 602         //System.out.println(" ---Tridiag transform matrix ---");\r
 603         //symm.print(System.out);\r
 604         //System.out.println();\r
 605         //System.out.println(" --- D vector ---");\r
 606         //symm.printD(System.out);\r
 607         //System.out.println();\r
 608         //System.out.println(" --- E vector ---");\r
 609         //symm.printE(System.out);\r
 610         //System.out.println();\r
 611         // Now produce the diagonalization matrix\r
 612         tstart = System.currentTimeMillis();\r
 613         symm.tqli();\r
 614         tend = System.currentTimeMillis();\r
 615 \r
 616         //System.out.println("Time take for tqli = " + (tend-tstart) + " ms");\r
 617         //System.out.println(" --- New diagonalization matrix ---");\r
 618         //symm.print(System.out);\r
 619         //System.out.println();\r
 620         //System.out.println(" --- D vector ---");\r
 621         //symm.printD(System.out);\r
 622         //System.out.println();\r
 623         //System.out.println(" --- E vector ---");\r
 624         //symm.printE(System.out);\r
 625         //System.out.println();\r
 626         //System.out.println(" --- First eigenvector --- ");\r
 627         //double[] eigenv = symm.getColumn(0);\r
 628         //for (int i=0; i < eigenv.length;i++) {\r
 629         //  Format.print(System.out,"%15.4f",eigenv[i]);\r
 630         // }\r
 631         //System.out.println();\r
 632         //double[] neigenv = origsymm.vectorPostMultiply(eigenv);\r
 633         //for (int i=0; i < neigenv.length;i++) {\r
 634         //  Format.print(System.out,"%15.4f",neigenv[i]/symm.d[0]);\r
 635         //}\r
 636         //System.out.println();\r
 637     }\r
 638 }\r