Merge branch 'documentation/JAL-2325_release2101' into releases/Release_2_10_Branch
[jalview.git] / src / jalview / schemes / 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.schemes;
22
23 import jalview.analysis.scoremodels.PairwiseSeqScoreModel;
24 import jalview.api.analysis.ScoreModelI;
25
26 public class ScoreMatrix extends PairwiseSeqScoreModel implements
27         ScoreModelI
28 {
29   String name;
30
31   @Override
32   public String getName()
33   {
34     return name;
35   }
36
37   /**
38    * reference to integer score matrix
39    */
40   int[][] matrix;
41
42   /**
43    * 0 for Protein Score matrix. 1 for dna score matrix
44    */
45   int type;
46
47   /**
48    * 
49    * @param name
50    *          Unique, human readable name for the matrix
51    * @param matrix
52    *          Pairwise scores indexed according to appropriate symbol alphabet
53    * @param type
54    *          0 for Protein, 1 for NA
55    */
56   ScoreMatrix(String name, int[][] matrix, int type)
57   {
58     this.matrix = matrix;
59     this.type = type;
60     this.name = name;
61   }
62
63   @Override
64   public boolean isDNA()
65   {
66     return type == 1;
67   }
68
69   @Override
70   public boolean isProtein()
71   {
72     return type == 0;
73   }
74
75   @Override
76   public int[][] getMatrix()
77   {
78     return matrix;
79   }
80
81   /**
82    * 
83    * @param A1
84    * @param A2
85    * @return score for substituting first char in A1 with first char in A2
86    */
87   public int getPairwiseScore(String A1, String A2)
88   {
89     return getPairwiseScore(A1.charAt(0), A2.charAt(0));
90   }
91
92   public int getPairwiseScore(char c, char d)
93   {
94     int pog = 0;
95
96     try
97     {
98       int a = (type == 0) ? ResidueProperties.aaIndex[c]
99               : ResidueProperties.nucleotideIndex[c];
100       int b = (type == 0) ? ResidueProperties.aaIndex[d]
101               : ResidueProperties.nucleotideIndex[d];
102
103       pog = matrix[a][b];
104     } catch (Exception e)
105     {
106       // System.out.println("Unknown residue in " + A1 + " " + A2);
107     }
108
109     return pog;
110   }
111
112   /**
113    * pretty print the matrix
114    */
115   public String toString()
116   {
117     return outputMatrix(false);
118   }
119
120   public String outputMatrix(boolean html)
121   {
122     StringBuffer sb = new StringBuffer();
123     int[] symbols = (type == 0) ? ResidueProperties.aaIndex
124             : ResidueProperties.nucleotideIndex;
125     int symMax = (type == 0) ? ResidueProperties.maxProteinIndex
126             : ResidueProperties.maxNucleotideIndex;
127     boolean header = true;
128     if (html)
129     {
130       sb.append("<table border=\"1\">");
131     }
132     for (char sym = 'A'; sym <= 'Z'; sym++)
133     {
134       if (symbols[sym] >= 0 && symbols[sym] < symMax)
135       {
136         if (header)
137         {
138           sb.append(html ? "<tr><td></td>" : "");
139           for (char sym2 = 'A'; sym2 <= 'Z'; sym2++)
140           {
141             if (symbols[sym2] >= 0 && symbols[sym2] < symMax)
142             {
143               sb.append((html ? "<td>&nbsp;" : "\t") + sym2
144                       + (html ? "&nbsp;</td>" : ""));
145             }
146           }
147           header = false;
148           sb.append(html ? "</tr>\n" : "\n");
149         }
150         if (html)
151         {
152           sb.append("<tr>");
153         }
154         sb.append((html ? "<td>" : "") + sym + (html ? "</td>" : ""));
155         for (char sym2 = 'A'; sym2 <= 'Z'; sym2++)
156         {
157           if (symbols[sym2] >= 0 && symbols[sym2] < symMax)
158           {
159             sb.append((html ? "<td>" : "\t")
160                     + matrix[symbols[sym]][symbols[sym2]]
161                     + (html ? "</td>" : ""));
162           }
163         }
164         sb.append(html ? "</tr>\n" : "\n");
165       }
166     }
167     if (html)
168     {
169       sb.append("</table>");
170     }
171     return sb.toString();
172   }
173 }