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