JAL-2403 JAL-1483 changes to ScoreModelI hierarchy and signatures to
[jalview.git] / src / jalview / analysis / scoremodels / PIDDistanceModel.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.DistanceScoreModelI;
24 import jalview.datamodel.AlignmentView;
25 import jalview.math.Matrix;
26 import jalview.math.MatrixI;
27 import jalview.util.Comparison;
28
29 public class PIDDistanceModel implements DistanceScoreModelI
30 {
31
32   @Override
33   public MatrixI findDistances(AlignmentView seqData)
34   {
35     String[] sequenceString = seqData
36             .getSequenceStrings(Comparison.GAP_SPACE);
37     int noseqs = sequenceString.length;
38     double[][] distance = new double[noseqs][noseqs];
39     for (int i = 0; i < (noseqs - 1); i++)
40     {
41       for (int j = i; j < noseqs; j++)
42       {
43         if (j == i)
44         {
45           distance[i][i] = 0;
46         }
47         else
48         {
49           distance[i][j] = 100 - Comparison.PID(sequenceString[i],
50                   sequenceString[j]);
51
52           distance[j][i] = distance[i][j];
53         }
54       }
55     }
56     return new Matrix(distance);
57   }
58
59   @Override
60   public String getName()
61   {
62     return "PID";
63   }
64
65   @Override
66   public boolean isDNA()
67   {
68     return true;
69   }
70
71   @Override
72   public boolean isProtein()
73   {
74     return true;
75   }
76
77   @Override
78   public String toString()
79   {
80     return "Percentage identity of sequences";
81   }
82 }