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