JAL-1620 version bump and release notes
[jalview.git] / src / jalview / analysis / AAFrequency.java
index 8fd60c4..8025882 100755 (executable)
@@ -1,24 +1,28 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.analysis;
 
 import java.util.*;
 
+import jalview.util.Format;
 import jalview.datamodel.*;
 
 /**
@@ -44,36 +48,38 @@ public class AAFrequency
 
   public static final String PROFILE = "P";
 
-  public static final Hashtable[] calculate(Vector sequences, int start,
-          int end)
+  public static final Hashtable[] calculate(List<SequenceI> list,
+          int start, int end)
   {
-    return calculate(sequences, start, end, false);
+    return calculate(list, start, end, false);
   }
 
-  public static final Hashtable[] calculate(Vector sequences, int start,
-          int end, boolean profile)
+  public static final Hashtable[] calculate(List<SequenceI> sequences,
+          int start, int end, boolean profile)
   {
     SequenceI[] seqs = new SequenceI[sequences.size()];
     int width = 0;
-    for (int i = 0; i < sequences.size(); i++)
+    synchronized (sequences)
     {
-      seqs[i] = (SequenceI) sequences.elementAt(i);
-      if (seqs[i].getLength() > width)
+      for (int i = 0; i < sequences.size(); i++)
       {
-        width = seqs[i].getLength();
+        seqs[i] = sequences.get(i);
+        if (seqs[i].getLength() > width)
+        {
+          width = seqs[i].getLength();
+        }
       }
-    }
-
-    Hashtable[] reply = new Hashtable[width];
 
-    if (end >= width)
-    {
-      end = width;
-    }
+      Hashtable[] reply = new Hashtable[width];
 
-    calculate(seqs, start, end, reply, profile);
+      if (end >= width)
+      {
+        end = width;
+      }
 
-    return reply;
+      calculate(seqs, start, end, reply, profile);
+      return reply;
+    }
   }
 
   public static final void calculate(SequenceI[] sequences, int start,
@@ -88,7 +94,7 @@ public class AAFrequency
     Hashtable residueHash;
     int maxCount, nongap, i, j, v, jSize = sequences.length;
     String maxResidue;
-    char c;
+    char c = '-';
     float percentage;
 
     int[] values = new int[255];
@@ -105,6 +111,12 @@ public class AAFrequency
 
       for (j = 0; j < jSize; j++)
       {
+        if (sequences[j] == null)
+        {
+          System.err
+                  .println("WARNING: Consensus skipping null sequence - possible race condition.");
+          continue;
+        }
         seq = sequences[j].getSequence();
         if (seq.length > i)
         {
@@ -134,25 +146,31 @@ public class AAFrequency
           values['-']++;
         }
       }
-
-      for (v = 'A'; v < 'Z'; v++)
+      if (jSize == 1)
+      {
+        maxResidue = String.valueOf(c);
+        maxCount = 1;
+      }
+      else
       {
-        if (values[v] < 2 || values[v] < maxCount)
+        for (v = 'A'; v < 'Z'; v++)
         {
-          continue;
-        }
+          if (values[v] < 2 || values[v] < maxCount)
+          {
+            continue;
+          }
 
-        if (values[v] > maxCount)
-        {
-          maxResidue = String.valueOf((char) v);
-        }
-        else if (values[v] == maxCount)
-        {
-          maxResidue += String.valueOf((char) v);
+          if (values[v] > maxCount)
+          {
+            maxResidue = String.valueOf((char) v);
+          }
+          else if (values[v] == maxCount)
+          {
+            maxResidue += String.valueOf((char) v);
+          }
+          maxCount = values[v];
         }
-        maxCount = values[v];
       }
-
       if (maxResidue.length() == 0)
       {
         maxResidue = "-";
@@ -166,11 +184,16 @@ public class AAFrequency
       residueHash.put(MAXCOUNT, new Integer(maxCount));
       residueHash.put(MAXRESIDUE, maxResidue);
 
-      percentage = ((float) maxCount * 100) / (float) jSize;
+      percentage = ((float) maxCount * 100) / jSize;
       residueHash.put(PID_GAPS, new Float(percentage));
 
-      percentage = ((float) maxCount * 100) / (float) nongap;
+      if (nongap > 0)
+      {
+        // calculate for non-gapped too
+        percentage = ((float) maxCount * 100) / nongap;
+      }
       residueHash.put(PID_NOGAPS, new Float(percentage));
+
       result[i] = residueHash;
     }
   }
@@ -186,56 +209,88 @@ public class AAFrequency
    * @param width
    * @param ignoreGapsInConsensusCalculation
    * @param includeAllConsSymbols
+   * @param nseq
    */
   public static void completeConsensus(AlignmentAnnotation consensus,
           Hashtable[] hconsensus, int iStart, int width,
           boolean ignoreGapsInConsensusCalculation,
-          boolean includeAllConsSymbols)
+          boolean includeAllConsSymbols, long nseq)
   {
     completeConsensus(consensus, hconsensus, iStart, width,
-            ignoreGapsInConsensusCalculation, includeAllConsSymbols, null); // new
-                                                                            // char[]
+            ignoreGapsInConsensusCalculation, includeAllConsSymbols, null,
+            nseq); // new
+    // char[]
     // { 'A', 'C', 'G', 'T', 'U' });
   }
 
   public static void completeConsensus(AlignmentAnnotation consensus,
           Hashtable[] hconsensus, int iStart, int width,
           boolean ignoreGapsInConsensusCalculation,
-          boolean includeAllConsSymbols, char[] alphabet)
+          boolean includeAllConsSymbols, char[] alphabet, long nseq)
   {
     float tval, value;
-    if (consensus==null || consensus.annotations==null || consensus.annotations.length<width)
+    if (consensus == null || consensus.annotations == null
+            || consensus.annotations.length < width)
     {
-      // called with a bad alignment annotation row - wait for it to be initialised properly
+      // called with a bad alignment annotation row - wait for it to be
+      // initialised properly
       return;
     }
+    String fmtstr = "%3.1f";
+    int precision = 0;
+    while (nseq >= 10)
+    {
+      precision++;
+      nseq /= 10;
+    }
+    final Format fmt;
+    if (precision > 1)
+    {
+      // if (precision>2)
+      {
+        fmtstr = "%" + (2 + precision) + "." + (precision) + "f";
+      }
+      fmt = new Format(fmtstr);
+    }
+    else
+    {
+      fmt = null;
+    }
     for (int i = iStart; i < width; i++)
     {
-      if (i>=hconsensus.length) {
-        // happens if sequences calculated over were shorter than alignment width
-        consensus.annotations[i]=null;
+      Hashtable hci;
+      if (i >= hconsensus.length || ((hci = hconsensus[i]) == null))
+      {
+        // happens if sequences calculated over were shorter than alignment
+        // width
+        consensus.annotations[i] = null;
         continue;
       }
       value = 0;
+      Float fv;
       if (ignoreGapsInConsensusCalculation)
       {
-        value = ((Float) hconsensus[i].get(AAFrequency.PID_NOGAPS))
-                .floatValue();
+        fv = (Float) hci.get(AAFrequency.PID_NOGAPS);
       }
       else
       {
-        value = ((Float) hconsensus[i].get(AAFrequency.PID_GAPS))
-                .floatValue();
+        fv = (Float) hci.get(AAFrequency.PID_GAPS);
       }
-
-      String maxRes = hconsensus[i].get(AAFrequency.MAXRESIDUE).toString();
-      String mouseOver = hconsensus[i].get(AAFrequency.MAXRESIDUE) + " ";
+      if (fv == null)
+      {
+        consensus.annotations[i] = null;
+        // data has changed below us .. give up and
+        continue;
+      }
+      value = fv.floatValue();
+      String maxRes = hci.get(AAFrequency.MAXRESIDUE).toString();
+      String mouseOver = hci.get(AAFrequency.MAXRESIDUE) + " ";
       if (maxRes.length() > 1)
       {
         mouseOver = "[" + maxRes + "] ";
         maxRes = "+";
       }
-      int[][] profile = (int[][]) hconsensus[i].get(AAFrequency.PROFILE);
+      int[][] profile = (int[][]) hci.get(AAFrequency.PROFILE);
       if (profile != null && includeAllConsSymbols)
       {
         mouseOver = "";
@@ -243,12 +298,10 @@ public class AAFrequency
         {
           for (int c = 0; c < alphabet.length; c++)
           {
-            tval = ((float) profile[0][alphabet[c]])
-                    * 100f
-                    / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
-                            : 0];
+            tval = profile[0][alphabet[c]] * 100f
+                    / profile[1][ignoreGapsInConsensusCalculation ? 1 : 0];
             mouseOver += ((c == 0) ? "" : "; ") + alphabet[c] + " "
-                    + ((int) tval) + "%";
+                    + ((fmt != null) ? fmt.form(tval) : ((int) tval)) + "%";
           }
         }
         else
@@ -259,7 +312,7 @@ public class AAFrequency
           {
             ca[c] = new char[]
             { (char) c };
-            vl[c] = (float) profile[0][c];
+            vl[c] = profile[0][c];
           }
           ;
           jalview.util.QuickSort.sort(vl, ca);
@@ -267,12 +320,13 @@ public class AAFrequency
           {
             if (((char[]) ca[c])[0] != '-')
             {
-              tval = ((float) profile[0][((char[]) ca[c])[0]])
+              tval = profile[0][((char[]) ca[c])[0]]
                       * 100f
-                      / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
-                              : 0];
+                      / profile[1][ignoreGapsInConsensusCalculation ? 1 : 0];
               mouseOver += ((p == 0) ? "" : "; ") + ((char[]) ca[c])[0]
-                      + " " + ((int) tval) + "%";
+                      + " "
+                      + ((fmt != null) ? fmt.form(tval) : ((int) tval))
+                      + "%";
               p++;
 
             }
@@ -282,7 +336,8 @@ public class AAFrequency
       }
       else
       {
-        mouseOver += ((int) value + "%");
+        mouseOver += ((fmt != null) ? fmt.form(value) : ((int) value))
+                + "%";
       }
       consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
               value);
@@ -308,18 +363,20 @@ public class AAFrequency
     {
       ca[c] = new char[]
       { (char) c };
-      vl[c] = (float) profile[0][c];
+      vl[c] = profile[0][c];
     }
     ;
     jalview.util.QuickSort.sort(vl, ca);
-    rtnval[0] = 1;
+    rtnval[0] = 2;
+    rtnval[1] = 0;
     for (int c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
     {
       if (((char[]) ca[c])[0] != '-')
       {
         rtnval[rtnval[0]++] = ((char[]) ca[c])[0];
-        rtnval[rtnval[0]++] = (int) (((float) profile[0][((char[]) ca[c])[0]]) * 100f / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
+        rtnval[rtnval[0]] = (int) (profile[0][((char[]) ca[c])[0]] * 100f / profile[1][ignoreGapsInConsensusCalculation ? 1
                 : 0]);
+        rtnval[1] += rtnval[rtnval[0]++];
       }
     }
     return rtnval;