JAL-2403 improved ScoreModelI hierarchy as per Kira's review suggestions
[jalview.git] / src / jalview / analysis / scoremodels / SmithWatermanModel.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.analysis.AlignSeq;
24 import jalview.api.analysis.SimilarityParamsI;
25 import jalview.datamodel.AlignmentView;
26 import jalview.datamodel.SequenceI;
27 import jalview.math.Matrix;
28 import jalview.math.MatrixI;
29 import jalview.util.Comparison;
30
31 /**
32  * A class that computes pairwise similarity scores using the Smith-Waterman
33  * alignment algorithm
34  */
35 public class SmithWatermanModel extends SimilarityScoreModel
36 {
37   private static final String NAME = "Smith Waterman Score";
38
39   private String description;
40
41   /**
42    * Constructor
43    */
44   public SmithWatermanModel()
45   {
46   }
47
48   @Override
49   public MatrixI findSimilarities(AlignmentView seqData,
50           SimilarityParamsI options)
51   {
52     SequenceI[] sequenceString = seqData.getVisibleAlignment(
53             Comparison.GAP_SPACE).getSequencesArray();
54     int noseqs = sequenceString.length;
55     double[][] distances = new double[noseqs][noseqs];
56
57     double max = -1;
58
59     for (int i = 0; i < (noseqs - 1); i++)
60     {
61       for (int j = i; j < noseqs; j++)
62       {
63         AlignSeq as = new AlignSeq(sequenceString[i], sequenceString[j],
64                 seqData.isNa() ? "dna" : "pep");
65         as.calcScoreMatrix();
66         as.traceAlignment();
67         as.printAlignment(System.out);
68         distances[i][j] = as.maxscore;
69
70         if (max < distances[i][j])
71         {
72           max = distances[i][j];
73         }
74       }
75     }
76
77     return new Matrix(distances);
78   }
79
80   @Override
81   public String getName()
82   {
83     return NAME;
84   }
85
86   @Override
87   public boolean isDNA()
88   {
89     return true;
90   }
91
92   @Override
93   public boolean isProtein()
94   {
95     return true;
96   }
97
98   @Override
99   public String getDescription()
100   {
101     return description;
102   }
103 }