update author list in license for (JAL-826)
[jalview.git] / src / jalview / datamodel / BinarySequence.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
10  * 
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.datamodel;
19
20 import jalview.schemes.*;
21
22 /**
23  * DOCUMENT ME!
24  * 
25  * @author $author$
26  * @version $Revision$
27  */
28 public class BinarySequence extends Sequence
29 {
30   int[] binary;
31
32   double[] dbinary;
33
34   /**
35    * Creates a new BinarySequence object.
36    * 
37    * @param s
38    *          DOCUMENT ME!
39    */
40   public BinarySequence(String s)
41   {
42     super("", s, 0, s.length());
43   }
44
45   /**
46    * DOCUMENT ME!
47    */
48   public void encode()
49   {
50     // Set all matrix to 0
51     dbinary = new double[getSequence().length * 21];
52
53     int nores = 21;
54
55     for (int i = 0; i < dbinary.length; i++)
56     {
57       dbinary[i] = 0.0;
58     }
59
60     for (int i = 0; i < getSequence().length; i++)
61     {
62       int aanum = 20;
63
64       try
65       {
66         aanum = ResidueProperties.aaIndex[getCharAt(i)];
67       } catch (NullPointerException e)
68       {
69         aanum = 20;
70       }
71
72       if (aanum > 20)
73       {
74         aanum = 20;
75       }
76
77       dbinary[(i * nores) + aanum] = 1.0;
78     }
79   }
80
81   /**
82    * ancode using substitution matrix given in matrix
83    * 
84    * @param matrix
85    */
86   public void matrixEncode(ScoreMatrix matrix)
87   {
88     matrixEncode(matrix.isDNA() ? ResidueProperties.nucleotideIndex
89             : ResidueProperties.aaIndex, matrix.getMatrix());
90   }
91
92   /**
93    * DOCUMENT ME!
94    */
95   public void blosumEncode()
96   {
97     matrixEncode(ResidueProperties.aaIndex, ResidueProperties.getBLOSUM62());
98   }
99
100   private void matrixEncode(int[] aaIndex, int[][] matrix)
101   {
102     // Set all matrix to 0
103     dbinary = new double[getSequence().length * 21];
104
105     int nores = 21;
106
107     // for (int i = 0; i < dbinary.length; i++) {
108     // dbinary[i] = 0.0;
109     // }
110     for (int i = 0; i < getSequence().length; i++)
111     {
112       int aanum = 20;
113
114       try
115       {
116         aanum = aaIndex[getCharAt(i)];
117       } catch (NullPointerException e)
118       {
119         aanum = 20;
120       }
121
122       if (aanum > 20)
123       {
124         aanum = 20;
125       }
126
127       // Do the blosum thing
128
129       for (int j = 0; j < 20; j++)
130       {
131         dbinary[(i * nores) + j] = matrix[aanum][j];
132       }
133     }
134   }
135
136   /**
137    * DOCUMENT ME!
138    * 
139    * @return DOCUMENT ME!
140    */
141   public String toBinaryString()
142   {
143     String out = "";
144
145     for (int i = 0; i < binary.length; i++)
146     {
147       out += (new Integer(binary[i])).toString();
148
149       if (i < (binary.length - 1))
150       {
151         out += " ";
152       }
153     }
154
155     return out;
156   }
157
158   /**
159    * DOCUMENT ME!
160    * 
161    * @return DOCUMENT ME!
162    */
163   public double[] getDBinary()
164   {
165     return dbinary;
166   }
167
168 }