src/jalview/analysis/scoremodels/ScoreMatrix.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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.analysis.scoremodels;
  22
  23 import jalview.api.analysis.PairwiseScoreModelI;
  24 import jalview.api.analysis.SimilarityParamsI;
  25 import jalview.api.analysis.SimilarityScoreModelI;
  26 import jalview.datamodel.AlignmentView;
  27 import jalview.math.Matrix;
  28 import jalview.math.MatrixI;
  29 import jalview.util.Comparison;
  30
  31 import java.util.Arrays;
  32
  33 /**
  34  * A class that models a substitution score matrix for any given alphabet of
  35  * symbols
  36  */
  37 public class ScoreMatrix implements SimilarityScoreModelI,
  38         PairwiseScoreModelI
  39 {
  40   /*
  41    * this fields records which gap character (if any) is used in the alphabet;
  42    * space, dash or dot are recognised as gap symbols
  43    */
  44   private char gapCharacter = '0';
  45
  46   /*
  47    * Jalview 2.10.1 treated gaps as X (peptide) or N (nucleotide)
  48    * for pairwise scoring; 2.10.2 uses gap score (last column) in
  49    * score matrix (JAL-2397)
  50    * Set this flag to true (via Groovy) for 2.10.1 behaviour
  51    */
  52   private static boolean scoreGapAsAny = false;
  53
  54   public static final short UNMAPPED = (short) -1;
  55
  56   private static final String BAD_ASCII_ERROR = "Unexpected character %s in getPairwiseScore";
  57
  58   private static final int MAX_ASCII = 127;
  59
  60   /*
  61    * the name of the model as shown in menus
  62    * each score model in use should have a unique name
  63    */
  64   private String name;
  65
  66   /*
  67    * a description for the model as shown in tooltips
  68    */
  69   private String description;
  70
  71   /*
  72    * the characters that the model provides scores for
  73    */
  74   private char[] symbols;
  75
  76   /*
  77    * the score matrix; both dimensions must equal the number of symbols
  78    * matrix[i][j] is the substitution score for replacing symbols[i] with symbols[j]
  79    */
  80   private float[][] matrix;
  81
  82   /*
  83    * quick lookup to convert from an ascii character value to the index
  84    * of the corresponding symbol in the score matrix
  85    */
  86   private short[] symbolIndex;
  87
  88   /*
  89    * true for Protein Score matrix, false for dna score matrix
  90    */
  91   private boolean peptide;
  92
  93   private float minValue;
  94
  95   private float maxValue;
  96
  97   /**
  98    * Constructor given a name, symbol alphabet, and matrix of scores for pairs
  99    * of symbols. The matrix should be square and of the same size as the
 100    * alphabet, for example 20x20 for a 20 symbol alphabet.
 101    *
 102    * @param theName
 103    *          Unique, human readable name for the matrix
 104    * @param alphabet
 105    *          the symbols to which scores apply
 106    * @param values
 107    *          Pairwise scores indexed according to the symbol alphabet
 108    */
 109   public ScoreMatrix(String theName, char[] alphabet, float[][] values)
 110   {
 111     if (alphabet.length != values.length)
 112     {
 113       throw new IllegalArgumentException(
 114               "score matrix size must match alphabet size");
 115     }
 116     for (float[] row : values)
 117     {
 118       if (row.length != alphabet.length)
 119       {
 120         throw new IllegalArgumentException(
 121                 "score matrix size must be square");
 122       }
 123     }
 124
 125     this.matrix = values;
 126     this.name = theName;
 127     this.symbols = alphabet;
 128
 129     symbolIndex = buildSymbolIndex(alphabet);
 130
 131     findMinMax();
 132
 133     /*
 134      * crude heuristic for now...
 135      */
 136     peptide = alphabet.length >= 20;
 137   }
 138
 139   /**
 140    * Record the minimum and maximum score values
 141    */
 142   protected void findMinMax()
 143   {
 144     float min = Float.MAX_VALUE;
 145     float max = -Float.MAX_VALUE;
 146     if (matrix != null)
 147     {
 148       for (float[] row : matrix)
 149       {
 150         if (row != null)
 151         {
 152           for (float f : row)
 153           {
 154             min = Math.min(min, f);
 155             max = Math.max(max, f);
 156           }
 157         }
 158       }
 159     }
 160     minValue = min;
 161     maxValue = max;
 162   }
 163
 164   /**
 165    * Returns an array A where A[i] is the position in the alphabet array of the
 166    * character whose value is i. For example if the alphabet is { 'A', 'D', 'X'
 167    * } then A['D'] = A[68] = 1.
 168    * <p>
 169    * Unmapped characters (not in the alphabet) get an index of -1.
 170    * <p>
 171    * Mappings are added automatically for lower case symbols (for non case
 172    * sensitive scoring), unless they are explicitly present in the alphabet (are
 173    * scored separately in the score matrix).
 174    * <p>
 175    * the gap character (space, dash or dot) included in the alphabet (if any) is
 176    * recorded in a field
 177    *
 178    * @param alphabet
 179    * @return
 180    */
 181   short[] buildSymbolIndex(char[] alphabet)
 182   {
 183     short[] index = new short[MAX_ASCII + 1];
 184     Arrays.fill(index, UNMAPPED);
 185     short pos = 0;
 186     for (char c : alphabet)
 187     {
 188       if (Comparison.isGap(c))
 189       {
 190         gapCharacter = c;
 191       }
 192
 193       if (c <= MAX_ASCII)
 194       {
 195         index[c] = pos;
 196       }
 197
 198       /*
 199        * also map lower-case character (unless separately mapped)
 200        */
 201       if (c >= 'A' && c <= 'Z')
 202       {
 203         short lowerCase = (short) (c + ('a' - 'A'));
 204         if (index[lowerCase] == UNMAPPED)
 205         {
 206           index[lowerCase] = pos;
 207         }
 208       }
 209       pos++;
 210     }
 211     return index;
 212   }
 213
 214   @Override
 215   public String getName()
 216   {
 217     return name;
 218   }
 219
 220   @Override
 221   public String getDescription()
 222   {
 223     return description;
 224   }
 225
 226   @Override
 227   public boolean isDNA()
 228   {
 229     return !peptide;
 230   }
 231
 232   @Override
 233   public boolean isProtein()
 234   {
 235     return peptide;
 236   }
 237
 238   /**
 239    * Returns a copy of the score matrix as used in getPairwiseScore. If using
 240    * this matrix directly, callers <em>must</em> also call
 241    * <code>getMatrixIndex</code> in order to get the matrix index for each
 242    * character (symbol).
 243    *
 244    * @return
 245    * @see #getMatrixIndex(char)
 246    */
 247   public float[][] getMatrix()
 248   {
 249     float[][] v = new float[matrix.length][matrix.length];
 250     for (int i = 0; i < matrix.length; i++)
 251     {
 252       v[i] = Arrays.copyOf(matrix[i], matrix[i].length);
 253     }
 254     return v;
 255   }
 256
 257   /**
 258    * Answers the matrix index for a given character, or -1 if unmapped in the
 259    * matrix. Use this method only if using <code>getMatrix</code> in order to
 260    * compute scores directly (without symbol lookup) for efficiency.
 261    *
 262    * @param c
 263    * @return
 264    * @see #getMatrix()
 265    */
 266   public int getMatrixIndex(char c)
 267   {
 268     if (c < symbolIndex.length)
 269     {
 270       return symbolIndex[c];
 271     }
 272     else
 273     {
 274       return UNMAPPED;
 275     }
 276   }
 277
 278   /**
 279    * Answers the matrix index for the gap character, or -1 if unmapped in the
 280    * matrix. Use this method only if using <code>getMatrix</code> in order to
 281    * compute scores directly (without symbol lookup) for efficiency.
 282    *
 283    * @return
 284    * @see #getMatrix()
 285    */
 286   public int getGapIndex()
 287   {
 288     return getMatrixIndex(gapCharacter);
 289   }
 290
 291   /**
 292    * Returns the pairwise score for substituting c with d, or zero if c or d is
 293    * an unscored or unexpected character
 294    */
 295   @Override
 296   public float getPairwiseScore(char c, char d)
 297   {
 298     if (c >= symbolIndex.length)
 299     {
 300       System.err.println(String.format(BAD_ASCII_ERROR, c));
 301       return 0;
 302     }
 303     if (d >= symbolIndex.length)
 304     {
 305       System.err.println(String.format(BAD_ASCII_ERROR, d));
 306       return 0;
 307     }
 308
 309     int cIndex = symbolIndex[c];
 310     int dIndex = symbolIndex[d];
 311     if (cIndex != UNMAPPED && dIndex != UNMAPPED)
 312     {
 313       return matrix[cIndex][dIndex];
 314     }
 315
 316     /*
 317      * one or both symbols not found in the matrix
 318      * note: a possible strategy here would be to return the minimum
 319      * matrix value if c != d
 320      */
 321     return 0;
 322   }
 323
 324   /**
 325    * pretty print the matrix
 326    */
 327   @Override
 328   public String toString()
 329   {
 330     return outputMatrix(false);
 331   }
 332
 333   /**
 334    * Print the score matrix, optionally formatted as html, with the alphabet
 335    * symbols as column headings and at the start of each row.
 336    * <p>
 337    * The non-html format should give an output which can be parsed as a score
 338    * matrix file
 339    *
 340    * @param html
 341    * @return
 342    */
 343   public String outputMatrix(boolean html)
 344   {
 345     StringBuilder sb = new StringBuilder(512);
 346
 347     /*
 348      * heading row with alphabet
 349      */
 350     if (html)
 351     {
 352       sb.append("<table border=\"1\">");
 353       sb.append(html ? "<tr><th></th>" : "");
 354     }
 355     else
 356     {
 357       sb.append("ScoreMatrix ").append(getName()).append("\n");
 358     }
 359     for (char sym : symbols)
 360     {
 361       if (html)
 362       {
 363         sb.append("<th>&nbsp;").append(sym).append("&nbsp;</th>");
 364       }
 365       else
 366       {
 367         sb.append("\t").append(sym);
 368       }
 369     }
 370     sb.append(html ? "</tr>\n" : "\n");
 371
 372     /*
 373      * table of scores
 374      */
 375     for (char c1 : symbols)
 376     {
 377       if (html)
 378       {
 379         sb.append("<tr><td>");
 380       }
 381       sb.append(c1).append(html ? "</td>" : "");
 382       for (char c2 : symbols)
 383       {
 384         sb.append(html ? "<td>" : "\t")
 385                 .append(matrix[symbolIndex[c1]][symbolIndex[c2]])
 386                 .append(html ? "</td>" : "");
 387       }
 388       sb.append(html ? "</tr>\n" : "\n");
 389     }
 390     if (html)
 391     {
 392       sb.append("</table>");
 393     }
 394     return sb.toString();
 395   }
 396
 397   /**
 398    * Answers the number of symbols coded for (also equal to the number of rows
 399    * and columns of the score matrix)
 400    *
 401    * @return
 402    */
 403   public int getSize()
 404   {
 405     return symbols.length;
 406   }
 407
 408   /**
 409    * Computes an NxN matrix where N is the number of sequences, and entry [i, j]
 410    * is sequence[i] pairwise multiplied with sequence[j], as a sum of scores
 411    * computed using the current score matrix. For example
 412    * <ul>
 413    * <li>Sequences:</li>
 414    * <li>FKL</li>
 415    * <li>R-D</li>
 416    * <li>QIA</li>
 417    * <li>GWC</li>
 418    * <li>Score matrix is BLOSUM62</li>
 419    * <li>Gaps treated same as X (unknown)</li>
 420    * <li>product [0, 0] = F.F + K.K + L.L = 6 + 5 + 4 = 15</li>
 421    * <li>product [1, 1] = R.R + -.- + D.D = 5 + -1 + 6 = 10</li>
 422    * <li>product [2, 2] = Q.Q + I.I + A.A = 5 + 4 + 4 = 13</li>
 423    * <li>product [3, 3] = G.G + W.W + C.C = 6 + 11 + 9 = 26</li>
 424    * <li>product[0, 1] = F.R + K.- + L.D = -3 + -1 + -3 = -8
 425    * <li>and so on</li>
 426    * </ul>
 427    */
 428   @Override
 429   public MatrixI findSimilarities(AlignmentView seqstrings,
 430           SimilarityParamsI options)
 431   {
 432     char gapChar = scoreGapAsAny ? (seqstrings.isNa() ? 'N' : 'X')
 433             : gapCharacter;
 434     String[] seqs = seqstrings.getSequenceStrings(gapChar);
 435     return findSimilarities(seqs, options);
 436   }
 437
 438   /**
 439    * Computes pairwise similarities of a set of sequences using the given
 440    * parameters
 441    *
 442    * @param seqs
 443    * @param params
 444    * @return
 445    */
 446   protected MatrixI findSimilarities(String[] seqs, SimilarityParamsI params)
 447   {
 448     double[][] values = new double[seqs.length][];
 449     for (int row = 0; row < seqs.length; row++)
 450     {
 451       values[row] = new double[seqs.length];
 452       for (int col = 0; col < seqs.length; col++)
 453       {
 454         double total = computeSimilarity(seqs[row], seqs[col], params);
 455         values[row][col] = total;
 456       }
 457     }
 458     return new Matrix(values);
 459   }
 460
 461   /**
 462    * Calculates the pairwise similarity of two strings using the given
 463    * calculation parameters
 464    *
 465    * @param seq1
 466    * @param seq2
 467    * @param params
 468    * @return
 469    */
 470   protected double computeSimilarity(String seq1, String seq2,
 471           SimilarityParamsI params)
 472   {
 473     int len1 = seq1.length();
 474     int len2 = seq2.length();
 475     double total = 0;
 476
 477     int width = Math.max(len1, len2);
 478     for (int i = 0; i < width; i++)
 479     {
 480       if (i >= len1 || i >= len2)
 481       {
 482         /*
 483          * off the end of one sequence; stop if we are only matching
 484          * on the shorter sequence length, else treat as trailing gap
 485          */
 486         if (params.denominateByShortestLength())
 487         {
 488           break;
 489         }
 490       }
 491
 492       char c1 = i >= len1 ? gapCharacter : seq1.charAt(i);
 493       char c2 = i >= len2 ? gapCharacter : seq2.charAt(i);
 494       boolean gap1 = Comparison.isGap(c1);
 495       boolean gap2 = Comparison.isGap(c2);
 496
 497       if (gap1 && gap2)
 498       {
 499         /*
 500          * gap-gap: include if options say so, else ignore
 501          */
 502         if (!params.includeGappedColumns())
 503         {
 504           continue;
 505         }
 506       }
 507       else if (gap1 || gap2)
 508       {
 509         /*
 510          * gap-residue: score if options say so
 511          */
 512         if (!params.includeGaps())
 513         {
 514           continue;
 515         }
 516       }
 517       float score = getPairwiseScore(c1, c2);
 518       total += score;
 519     }
 520     return total;
 521   }
 522
 523   /**
 524    * Answers a hashcode computed from the symbol alphabet and the matrix score
 525    * values
 526    */
 527   @Override
 528   public int hashCode()
 529   {
 530     int hs = Arrays.hashCode(symbols);
 531     for (float[] row : matrix)
 532     {
 533       hs = hs * 31 + Arrays.hashCode(row);
 534     }
 535     return hs;
 536   }
 537
 538   /**
 539    * Answers true if the argument is a ScoreMatrix with the same symbol alphabet
 540    * and score values, else false
 541    */
 542   @Override
 543   public boolean equals(Object obj)
 544   {
 545     if (!(obj instanceof ScoreMatrix))
 546     {
 547       return false;
 548     }
 549     ScoreMatrix sm = (ScoreMatrix) obj;
 550     if (Arrays.equals(symbols, sm.symbols)
 551             && Arrays.deepEquals(matrix, sm.matrix))
 552     {
 553       return true;
 554     }
 555     return false;
 556   }
 557
 558   /**
 559    * Returns the alphabet the matrix scores for, as a string of characters
 560    *
 561    * @return
 562    */
 563   String getSymbols()
 564   {
 565     return new String(symbols);
 566   }
 567
 568   public void setDescription(String desc)
 569   {
 570     description = desc;
 571   }
 572
 573   public float getMinimumScore()
 574   {
 575     return minValue;
 576   }
 577
 578   public float getMaximumScore()
 579   {
 580     return maxValue;
 581   }
 582 }