moving word methods to MapList and begin bug-fix for single-residue codon span featur...
[jalview.git] / src / jalview / analysis / AlignmentSorter.java
index 40ad372..ea8d4e5 100755 (executable)
@@ -1,48 +1,39 @@
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
 package jalview.analysis;\r
 \r
+import java.util.*;\r
+\r
 import jalview.datamodel.*;\r
 import jalview.util.*;\r
-import jalview.io.*;\r
-\r
-import java.util.*;\r
 \r
 /** Data structure to hold and manipulate a multiple sequence alignment\r
  */\r
-public class AlignmentSorter {\r
-\r
-  private AlignmentSorter() {\r
-    try\r
-    {\r
-      jbInit();\r
-    }\r
-    catch (Exception ex)\r
-    {\r
-      ex.printStackTrace();\r
-    }\r
-  }\r
-\r
-  public static void sortGroups(AlignmentI align) {\r
-    Vector groups = align.getGroups();\r
-    int    nGroup = groups.size();\r
-\r
-    float[]  arr = new float [nGroup];\r
-    Object[] s   = new Object[nGroup];\r
-\r
-    for (int i=0; i < nGroup; i++) {\r
-      arr[i] = ((SequenceGroup)groups.elementAt(i)).getSize();\r
-      s[i]   = groups.elementAt(i);\r
-    }\r
-\r
-    QuickSort.sort(arr,s);\r
-\r
-    Vector newg = new Vector(nGroup);\r
-\r
-    for (int i=nGroup-1; i >= 0; i--) {\r
-      newg.addElement(s[i]);\r
-    }\r
-\r
-    //    align.setGroups(newg);\r
-  }\r
+public class AlignmentSorter\r
+{\r
+  static boolean sortIdAscending = true;\r
+  static int lastGroupHash = 0;\r
+  static boolean sortGroupAscending = true;\r
+  static AlignmentOrder lastOrder = null;\r
+  static boolean sortOrderAscending = true;\r
+  static NJTree lastTree = null;\r
+  static boolean sortTreeAscending = true;\r
 \r
   /**\r
    * Sort by Percentage Identity\r
@@ -50,163 +41,302 @@ public class AlignmentSorter {
    * @param align AlignmentI\r
    * @param s SequenceI\r
    */\r
-  public static void sortByPID(AlignmentI align, SequenceI s) {\r
+  public static void sortByPID(AlignmentI align, SequenceI s)\r
+  {\r
     int nSeq = align.getHeight();\r
 \r
-    float     scores[] = new float[nSeq];\r
-    SequenceI seqs[]   = new SequenceI[nSeq];\r
+    float[] scores = new float[nSeq];\r
+    SequenceI[] seqs = new SequenceI[nSeq];\r
 \r
-    for (int i = 0; i < nSeq; i++) {\r
-      scores[i] = Comparison.compare(align.getSequenceAt(i),s);\r
-      seqs[i]   = align.getSequenceAt(i);\r
+    for (int i = 0; i < nSeq; i++)\r
+    {\r
+      scores[i] = Comparison.PID(align.getSequenceAt(i).getSequenceAsString(),\r
+                                 s.getSequenceAsString());\r
+      seqs[i] = align.getSequenceAt(i);\r
     }\r
 \r
-    QuickSort.sort(scores,0,scores.length-1,seqs);\r
+    QuickSort.sort(scores, 0, scores.length - 1, seqs);\r
 \r
-   setReverseOrder(align,seqs);\r
+    setReverseOrder(align, seqs);\r
   }\r
 \r
-  private static void setReverseOrder(AlignmentI align, SequenceI [] seqs) {\r
+  /**\r
+   * Reverse the order of the sort\r
+   *\r
+   * @param align DOCUMENT ME!\r
+   * @param seqs DOCUMENT ME!\r
+   */\r
+  private static void setReverseOrder(AlignmentI align, SequenceI[] seqs)\r
+  {\r
     int nSeq = seqs.length;\r
 \r
     int len = 0;\r
-    if (nSeq%2 == 0) {\r
-      len = nSeq/2;\r
-    } else {\r
-      len = (nSeq+1)/2;\r
+\r
+    if ( (nSeq % 2) == 0)\r
+    {\r
+      len = nSeq / 2;\r
+    }\r
+    else\r
+    {\r
+      len = (nSeq + 1) / 2;\r
     }\r
 \r
-// NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work\r
-    for (int i = 0; i < len; i++) {\r
+    // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work\r
+    for (int i = 0; i < len; i++)\r
+    {\r
       //SequenceI tmp = seqs[i];\r
-      align.getSequences().setElementAt(seqs[nSeq-i-1],i);\r
-      align.getSequences().setElementAt(seqs[i],nSeq-i-1);\r
+      align.getSequences().setElementAt(seqs[nSeq - i - 1], i);\r
+      align.getSequences().setElementAt(seqs[i], nSeq - i - 1);\r
     }\r
   }\r
 \r
-  private static void setOrder(AlignmentI align, Vector tmp) {\r
-    setOrder(align,vectorSubsetToArray(tmp, align.getSequences()));\r
+  /**\r
+   * Sets the Alignment object with the given sequences\r
+   *\r
+   * @param align Alignment object to be updated\r
+   * @param tmp sequences as a vector\r
+   */\r
+  private static void setOrder(AlignmentI align, Vector tmp)\r
+  {\r
+    setOrder(align, vectorSubsetToArray(tmp, align.getSequences()));\r
   }\r
 \r
-  private static void setOrder(AlignmentI align, SequenceI [] seqs) {\r
-      // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work\r
+  /**\r
+   * Sets the Alignment object with the given sequences\r
+   *\r
+   * @param align DOCUMENT ME!\r
+   * @param seqs sequences as an array\r
+   */\r
+  public static void setOrder(AlignmentI align, SequenceI[] seqs)\r
+  {\r
+    // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work\r
+    Vector algn = align.getSequences();\r
+    Vector tmp = new Vector();\r
 \r
-      Vector algn = align.getSequences();\r
+    for (int i = 0; i < seqs.length; i++)\r
+    {\r
+      if (algn.contains(seqs[i]))\r
+      {\r
+        tmp.addElement(seqs[i]);\r
+      }\r
+    }\r
+\r
+    algn.removeAllElements();\r
+    //User may have hidden seqs, then clicked undo or redo\r
+    for (int i = 0; i < tmp.size(); i++)\r
+    {\r
+      algn.addElement(tmp.elementAt(i));\r
+    }\r
 \r
-      for (int i = 0, p = 0; i < seqs.length; i++)\r
-        algn.setElementAt(seqs[i], p++);\r
   }\r
-  /**    */\r
-  static boolean sortIdAscending = true;\r
-  public static void sortByID(AlignmentI align) {\r
+\r
+  /**\r
+   * Sorts by ID. Numbers are sorted before letters.\r
+   *\r
+   * @param align The alignment object to sort\r
+   */\r
+  public static void sortByID(AlignmentI align)\r
+  {\r
     int nSeq = align.getHeight();\r
 \r
-    String    ids[]   = new String[nSeq];\r
-    SequenceI seqs[]  = new SequenceI[nSeq];\r
+    String[] ids = new String[nSeq];\r
+    SequenceI[] seqs = new SequenceI[nSeq];\r
 \r
-    for (int i = 0; i < nSeq; i++) {\r
-      ids[i]  = align.getSequenceAt(i).getName();\r
+    for (int i = 0; i < nSeq; i++)\r
+    {\r
+      ids[i] = align.getSequenceAt(i).getName();\r
       seqs[i] = align.getSequenceAt(i);\r
     }\r
 \r
-    QuickSort.sort(ids,seqs);\r
+    QuickSort.sort(ids, seqs);\r
 \r
-    if(sortIdAscending)\r
-      setReverseOrder(align,seqs);\r
+    if (sortIdAscending)\r
+    {\r
+      setReverseOrder(align, seqs);\r
+    }\r
     else\r
+    {\r
       setOrder(align, seqs);\r
+    }\r
 \r
     sortIdAscending = !sortIdAscending;\r
   }\r
-  static int lastGroupHash = 0;\r
-  static boolean sortGroupAscending = true;\r
 \r
-  public static void sortByGroup(AlignmentI align) {\r
-    int    nSeq = align.getHeight();\r
-    Vector groups = align.getGroups();\r
-    if (groups.hashCode()!=lastGroupHash) {\r
-      sortGroupAscending=true;\r
+  /**\r
+   * Sorts the alignment by size of group.\r
+   * <br>Maintains the order of sequences in each group\r
+   * by order in given alignment object.\r
+   *\r
+   * @param align sorts the given alignment object by group\r
+   */\r
+  public static void sortByGroup(AlignmentI align)\r
+  {\r
+    //MAINTAINS ORIGNAL SEQUENCE ORDER,\r
+    //ORDERS BY GROUP SIZE\r
+    Vector groups = new Vector();\r
+\r
+    if (groups.hashCode() != lastGroupHash)\r
+    {\r
+      sortGroupAscending = true;\r
       lastGroupHash = groups.hashCode();\r
-    } else\r
-      sortGroupAscending = ! sortGroupAscending;\r
+    }\r
+    else\r
+    {\r
+      sortGroupAscending = !sortGroupAscending;\r
+    }\r
 \r
-    Vector seqs = new Vector();\r
+    //SORTS GROUPS BY SIZE\r
+    //////////////////////\r
+    for (int i = 0; i < align.getGroups().size(); i++)\r
+    {\r
+      SequenceGroup sg = (SequenceGroup) align.getGroups().elementAt(i);\r
 \r
-    for (int i=0; i < groups.size(); i++) {\r
-      SequenceGroup sg = (SequenceGroup)groups.elementAt(i);\r
+      for (int j = 0; j < groups.size(); j++)\r
+      {\r
+        SequenceGroup sg2 = (SequenceGroup) groups.elementAt(j);\r
 \r
-      for (int j = 0; j < sg.getSize(); j++) {\r
-        seqs.addElement(sg.getSequenceAt(j));\r
+        if (sg.getSize() > sg2.getSize())\r
+        {\r
+          groups.insertElementAt(sg, j);\r
+\r
+          break;\r
+        }\r
+      }\r
+\r
+      if (!groups.contains(sg))\r
+      {\r
+        groups.addElement(sg);\r
       }\r
     }\r
 \r
-    // Deletions can happen so this check may fail\r
-    /*\r
-     if (seqs.size() != nSeq) {\r
-      System.err.println("ERROR: tmp.size() != nseq in sortByGroups");\r
-      if (seqs.size() < nSeq) {\r
-        addStrays(align,seqs);\r
+    //NOW ADD SEQUENCES MAINTAINING ALIGNMENT ORDER\r
+    ///////////////////////////////////////////////\r
+    Vector seqs = new Vector();\r
+\r
+    for (int i = 0; i < groups.size(); i++)\r
+    {\r
+      SequenceGroup sg = (SequenceGroup) groups.elementAt(i);\r
+      SequenceI[] orderedseqs = sg.getSequencesInOrder(align);\r
+\r
+      for (int j = 0; j < orderedseqs.length; j++)\r
+      {\r
+        seqs.addElement(orderedseqs[j]);\r
       }\r
     }\r
-*/\r
-    if(sortGroupAscending)\r
-      setOrder(align,seqs);\r
-    else\r
-      setReverseOrder( align, vectorSubsetToArray(seqs, align.getSequences()));\r
 \r
+    if (sortGroupAscending)\r
+    {\r
+      setOrder(align, seqs);\r
+    }\r
+    else\r
+    {\r
+      setReverseOrder(align,\r
+                      vectorSubsetToArray(seqs, align.getSequences()));\r
+    }\r
   }\r
 \r
-  private static SequenceI [] vectorToArray(Vector tmp) {\r
+  /**\r
+   * Converts Vector to array.\r
+   * java 1.18 does not have Vector.toArray()\r
+   *\r
+   * @param tmp Vector of SequenceI objects\r
+   *\r
+   * @return array of Sequence[]\r
+   */\r
+  private static SequenceI[] vectorToArray(Vector tmp)\r
+  {\r
     SequenceI[] seqs = new SequenceI[tmp.size()];\r
 \r
-    for (int i=0; i < tmp.size(); i++) {\r
-      seqs[i] = (SequenceI)tmp.elementAt(i);\r
+    for (int i = 0; i < tmp.size(); i++)\r
+    {\r
+      seqs[i] = (SequenceI) tmp.elementAt(i);\r
     }\r
+\r
     return seqs;\r
   }\r
 \r
-  private static SequenceI [] vectorSubsetToArray(Vector tmp, Vector mask) {\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param tmp DOCUMENT ME!\r
+   * @param mask DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  private static SequenceI[] vectorSubsetToArray(Vector tmp, Vector mask)\r
+  {\r
     Vector seqs = new Vector();\r
-    int i,m, p;\r
-    boolean[] tmask = new boolean[m=mask.size()];\r
-    for (i=0; i<m; i++)\r
+    int i;\r
+    boolean[] tmask = new boolean[mask.size()];\r
+\r
+    for (i = 0; i < mask.size(); i++)\r
+    {\r
       tmask[i] = true;\r
-    for (i=0; i < tmp.size(); i++) {\r
-      Object sq;\r
-      if (mask.contains(sq=tmp.elementAt(i))) {\r
+    }\r
+\r
+    for (i = 0; i < tmp.size(); i++)\r
+    {\r
+      Object sq = tmp.elementAt(i);\r
+\r
+      if (mask.contains(sq) && tmask[mask.indexOf(sq)])\r
+      {\r
         tmask[mask.indexOf(sq)] = false;\r
         seqs.addElement(sq);\r
-        m--;\r
       }\r
     }\r
-    for (i=0; i<tmask.length; i++)\r
+\r
+    for (i = 0; i < tmask.length; i++)\r
+    {\r
       if (tmask[i])\r
+      {\r
         seqs.addElement(mask.elementAt(i));\r
+      }\r
+    }\r
+\r
     return vectorToArray(seqs);\r
   }\r
 \r
-  static AlignmentOrder lastOrder = null;\r
-  static boolean sortOrderAscending = true;\r
-\r
-  public static void sortBy(AlignmentI align, AlignmentOrder order) {\r
+  /**\r
+   * Sorts by a given AlignmentOrder object\r
+   *\r
+   * @param align Alignment to order\r
+   * @param order specified order for alignment\r
+   */\r
+  public static void sortBy(AlignmentI align, AlignmentOrder order)\r
+  {\r
     // Get an ordered vector of sequences which may also be present in align\r
     Vector tmp = order.getOrder();\r
-//    if (tmp.size()<align.getHeight())\r
-//      addStrays(align, tmp);\r
-    if (lastOrder==order)\r
-      sortOrderAscending=!sortOrderAscending;\r
+\r
+    if (lastOrder == order)\r
+    {\r
+      sortOrderAscending = !sortOrderAscending;\r
+    }\r
     else\r
-      sortOrderAscending=true;\r
+    {\r
+      sortOrderAscending = true;\r
+    }\r
 \r
     if (sortOrderAscending)\r
+    {\r
       setOrder(align, tmp);\r
+    }\r
     else\r
-      setReverseOrder(align, vectorSubsetToArray(tmp, align.getSequences()));\r
+    {\r
+      setReverseOrder(align,\r
+                      vectorSubsetToArray(tmp, align.getSequences()));\r
+    }\r
   }\r
-  static NJTree lastTree = null;\r
-  static boolean sortTreeAscending = true;\r
 \r
-  public static Vector getOrderByTree(AlignmentI align, NJTree tree) {\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param align alignment to order\r
+   * @param tree tree which has\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  private static Vector getOrderByTree(AlignmentI align, NJTree tree)\r
+  {\r
     int nSeq = align.getHeight();\r
 \r
     Vector tmp = new Vector();\r
@@ -218,64 +348,122 @@ public class AlignmentSorter {
       // TODO: JBPNote - decide if this is always an error\r
       // (eg. not when a tree is associated to another alignment which has more\r
       //  sequences)\r
-\r
       if (tmp.size() < nSeq)\r
       {\r
         addStrays(align, tmp);\r
       }\r
-      if (tmp.size() != nSeq)\r
-        System.err.println("ERROR: tmp.size()="+tmp.size()+" != nseq="+nSeq+" in getOrderByTree");\r
 \r
+      if (tmp.size() != nSeq)\r
+      {\r
+        System.err.println("ERROR: tmp.size()=" + tmp.size() +\r
+                           " != nseq=" + nSeq + " in getOrderByTree");\r
+      }\r
     }\r
+\r
     return tmp;\r
   }\r
 \r
-  public static void sortByTree(AlignmentI align, NJTree tree) {\r
+  /**\r
+   * Sorts the alignment by a given tree\r
+   *\r
+   * @param align alignment to order\r
+   * @param tree tree which has\r
+   */\r
+  public static void sortByTree(AlignmentI align, NJTree tree)\r
+  {\r
     Vector tmp = getOrderByTree(align, tree);\r
+\r
     // tmp should properly permute align with tree.\r
-    if(lastTree!=tree) {\r
+    if (lastTree != tree)\r
+    {\r
       sortTreeAscending = true;\r
       lastTree = tree;\r
-    } else {\r
+    }\r
+    else\r
+    {\r
       sortTreeAscending = !sortTreeAscending;\r
     }\r
-    if(sortTreeAscending)\r
-      setOrder(align,tmp);\r
+\r
+    if (sortTreeAscending)\r
+    {\r
+      setOrder(align, tmp);\r
+    }\r
     else\r
-      setReverseOrder(align, vectorSubsetToArray(tmp, align.getSequences()));\r
+    {\r
+      setReverseOrder(align,\r
+                      vectorSubsetToArray(tmp, align.getSequences()));\r
+    }\r
   }\r
 \r
-  private static void addStrays(AlignmentI align, Vector seqs) {\r
-    int    nSeq = align.getHeight();\r
-    for (int i=0;i<nSeq;i++) {\r
-      if (!seqs.contains(align.getSequenceAt(i))) {\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param align DOCUMENT ME!\r
+   * @param seqs DOCUMENT ME!\r
+   */\r
+  private static void addStrays(AlignmentI align, Vector seqs)\r
+  {\r
+    int nSeq = align.getHeight();\r
+\r
+    for (int i = 0; i < nSeq; i++)\r
+    {\r
+      if (!seqs.contains(align.getSequenceAt(i)))\r
+      {\r
         seqs.addElement(align.getSequenceAt(i));\r
       }\r
     }\r
-    if (nSeq != seqs.size()) {\r
-      System.err.println("ERROR: Size still not right even after addStrays");\r
+\r
+    if (nSeq != seqs.size())\r
+    {\r
+      System.err.println(\r
+          "ERROR: Size still not right even after addStrays");\r
     }\r
   }\r
 \r
-  public static Vector _sortByTree(SequenceNode node, Vector tmp, Vector seqset) {\r
-    if (node == null) {return tmp;}\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param node DOCUMENT ME!\r
+   * @param tmp DOCUMENT ME!\r
+   * @param seqset DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  private static Vector _sortByTree(SequenceNode node, Vector tmp,\r
+                                    Vector seqset)\r
+  {\r
+    if (node == null)\r
+    {\r
+      return tmp;\r
+    }\r
 \r
-    SequenceNode left = (SequenceNode)node.left();\r
-    SequenceNode right = (SequenceNode)node.right();\r
+    SequenceNode left = (SequenceNode) node.left();\r
+    SequenceNode right = (SequenceNode) node.right();\r
 \r
-    if (left == null && right == null) {\r
-      if (!node.isPlaceholder() && node.element()!=null)\r
+    if ( (left == null) && (right == null))\r
+    {\r
+      if (!node.isPlaceholder() && (node.element() != null))\r
+      {\r
         if (node.element() instanceof SequenceI)\r
+        {\r
           if (!tmp.contains(node.element()))\r
-              tmp.addElement((SequenceI)node.element());\r
-        return tmp;\r
+          {\r
+            tmp.addElement( (SequenceI) node.element());\r
+          }\r
+        }\r
+      }\r
 \r
-    } else {\r
-      _sortByTree(left,tmp, seqset);\r
-      _sortByTree(right,tmp, seqset);\r
+      return tmp;\r
     }\r
+    else\r
+    {\r
+      _sortByTree(left, tmp, seqset);\r
+      _sortByTree(right, tmp, seqset);\r
+    }\r
+\r
     return tmp;\r
   }\r
+\r
   // Ordering Objects\r
   // Alignment.sortBy(OrderObj) - sequence of sequence pointer refs in appropriate order\r
   //\r
@@ -284,16 +472,15 @@ public class AlignmentSorter {
    * recover the order of sequences given by the safe numbering scheme introducd\r
    * SeqsetUtils.uniquify.\r
    */\r
-  public static void recoverOrder(SequenceI[] alignment) {\r
+  public static void recoverOrder(SequenceI[] alignment)\r
+  {\r
     float[] ids = new float[alignment.length];\r
-    for (int i=0; i<alignment.length; i++)\r
+\r
+    for (int i = 0; i < alignment.length; i++)\r
+    {\r
       ids[i] = (new Float(alignment[i].getName().substring(8))).floatValue();\r
-    jalview.util.QuickSort.sort(ids, alignment);\r
-  }\r
+    }\r
 \r
-  private void jbInit()\r
-      throws Exception\r
-  {\r
+    jalview.util.QuickSort.sort(ids, alignment);\r
   }\r
-\r
 }\r