Merge branch 'docs/2_8_1_Release' into Release_2_8_1_Branch

[jalview.git] / src / jalview / analysis / AlignSeq.java

diff --git a/src/jalview/analysis/AlignSeq.java b/src/jalview/analysis/AlignSeq.java
index 5d28fc3..5b37934 100755 (executable)
--- a/src/jalview/analysis/AlignSeq.java
+++ b/src/jalview/analysis/AlignSeq.java
@@ -1,19 +1,20 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
+ * 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.
- * 
+ *  
  * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.analysis;
 
@@ -921,33 +922,41 @@ public class AlignSeq
 
   /**
    * compute the PID vector used by the redundancy filter.
-   * @param originalSequences - sequences in alignment that are to filtered
-   * @param omitHidden - null or strings to be analysed (typically, visible portion of each sequence in alignment) 
-   * @param start - first column in window for calculation
-   * @param end - last column in window for calculation
-   * @param ungapped - if true then use ungapped sequence to compute PID
-   * @return vector containing maximum PID for i-th sequence and any sequences longer than that seuqence 
+   * 
+   * @param originalSequences
+   *          - sequences in alignment that are to filtered
+   * @param omitHidden
+   *          - null or strings to be analysed (typically, visible portion of
+   *          each sequence in alignment)
+   * @param start
+   *          - first column in window for calculation
+   * @param end
+   *          - last column in window for calculation
+   * @param ungapped
+   *          - if true then use ungapped sequence to compute PID
+   * @return vector containing maximum PID for i-th sequence and any sequences
+   *         longer than that seuqence
    */
-  public static float[] computeRedundancyMatrix(SequenceI[] originalSequences,
-          String[] omitHidden, int start, int end, boolean ungapped)
+  public static float[] computeRedundancyMatrix(
+          SequenceI[] originalSequences, String[] omitHidden, int start,
+          int end, boolean ungapped)
   {
-    int height=originalSequences.length;
+    int height = originalSequences.length;
     float[] redundancy = new float[height];
-    int[] lngth=new int[height];
+    int[] lngth = new int[height];
     for (int i = 0; i < height; i++)
     {
       redundancy[i] = 0f;
-      lngth[i]=-1;
+      lngth[i] = -1;
     }
 
-
     // long start = System.currentTimeMillis();
 
     float pid;
     String seqi, seqj;
     for (int i = 0; i < height; i++)
     {
-      
+
       for (int j = 0; j < i; j++)
       {
         if (i == j)
@@ -965,28 +974,28 @@ public class AlignSeq
           seqi = omitHidden[i];
           seqj = omitHidden[j];
         }
-        if (lngth[i]==-1)
+        if (lngth[i] == -1)
         {
-          String ug=AlignSeq.extractGaps(Comparison.GapChars, seqi);
-          lngth[i]=ug.length();
+          String ug = AlignSeq.extractGaps(Comparison.GapChars, seqi);
+          lngth[i] = ug.length();
           if (ungapped)
           {
-            seqi=ug;
+            seqi = ug;
           }
         }
-        if (lngth[j]==-1)
+        if (lngth[j] == -1)
         {
-          String ug=AlignSeq.extractGaps(Comparison.GapChars, seqj);
-          lngth[j]=ug.length();
+          String ug = AlignSeq.extractGaps(Comparison.GapChars, seqj);
+          lngth[j] = ug.length();
           if (ungapped)
           {
-            seqj=ug;
+            seqj = ug;
           }
         }
         pid = Comparison.PID(seqi, seqj);
 
-        // use real sequence length rather than string length 
-        if (lngth[j]<lngth[i])
+        // use real sequence length rather than string length
+        if (lngth[j] < lngth[i])
         {
           redundancy[j] = Math.max(pid, redundancy[j]);
         }