0f849e33a49c29300316b26360c7b80f7ea916d3
[jalview.git] / src / jalview / analysis / Connectivity.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;
22
23 //import jalview.datamodel.AlignmentView;
24 import jalview.datamodel.AlignmentI;
25 import jalview.datamodel.SequenceI;
26 import jalview.viewmodel.AlignmentViewport;
27
28 import java.util.Hashtable;
29
30 /**
31  * @Author MorellThomas
32  */
33
34 public class Connectivity
35 {
36
37   /**
38    * Returns the number of unique connections for each sequence
39    * only connections with a score of above 0 count
40    * 
41    * @param av sequences
42    * @param scores alignment scores
43    *
44    * @return connectivity
45    */
46   public static Hashtable<SequenceI, Integer> getConnectivity(AlignmentViewport av, float[][] scores, byte dim) throws RuntimeException
47   {
48     SequenceI[] sequences = av.getAlignment().getSequencesArray();
49
50     Hashtable<SequenceI, Integer> connectivity = new Hashtable<SequenceI, Integer>();
51     // for each unique connection
52     for (int i = 0; i < sequences.length; i++)
53     {
54       connectivity.putIfAbsent(sequences[i], 0);
55       for (int j = 0; j < i; j++)
56       {
57         connectivity.putIfAbsent(sequences[j], 0);
58         int iOld = connectivity.get(sequences[i]);
59         int jOld = connectivity.get(sequences[j]); 
60         // count the connection if its score is not NaN
61         if (!Float.isNaN(scores[i][j]))
62         {
63           connectivity.put(sequences[i], ++iOld);
64           connectivity.put(sequences[j], ++jOld);
65         }
66       }
67     }
68
69     // if a sequence has too few connections, abort
70     connectivity.forEach((sequence, connection) ->
71     {
72       System.out.println(String.format("%s: %d", sequence.getName(), connection));
73       if (connection < dim)
74       {
75         // a popup saying that it failed would be nice
76         throw new ConnectivityException(sequence.getName(), connection, dim);
77       }
78     } );
79
80     return connectivity;
81   }
82
83 }