JAL-845 minor tidy / tests / javadoc tweaks
[jalview.git] / src / jalview / util / QuickSort.java
index 017921f..cedf656 100755 (executable)
@@ -1,41 +1,83 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * This program 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 2
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * 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.
- *
- * This program 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.
- *
+ *  
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.util;
 
+/**
+ * A class to perform efficient sorting of arrays of objects based on arrays of
+ * scores or other attributes. For example, residues by frequency.
+ * 
+ * @author gmcarstairs
+ *
+ */
 public class QuickSort
 {
+  /**
+   * Sorts both arrays with respect to ascending order of the items in the first
+   * array.
+   * 
+   * @param arr
+   * @param s
+   */
+  public static void sort(int[] arr, Object[] s)
+  {
+    sort(arr, 0, arr.length - 1, s);
+  }
+
+  /**
+   * Sorts both arrays with respect to ascending order of the items in the first
+   * array.
+   * 
+   * @param arr
+   * @param s
+   */
   public static void sort(float[] arr, Object[] s)
   {
     sort(arr, 0, arr.length - 1, s);
   }
-  
+
+  /**
+   * Sorts both arrays with respect to ascending order of the items in the first
+   * array.
+   * 
+   * @param arr
+   * @param s
+   */
   public static void sort(double[] arr, Object[] s)
   {
     sort(arr, 0, arr.length - 1, s);
   }
 
+  /**
+   * Sorts both arrays with respect to descending order of the items in the
+   * first array.
+   * 
+   * @param arr
+   * @param s
+   */
   public static void sort(String[] arr, Object[] s)
   {
     stringSort(arr, 0, arr.length - 1, s);
   }
 
-  public static void stringSort(String[] arr, int p, int r, Object[] s)
+  static void stringSort(String[] arr, int p, int r, Object[] s)
   {
     int q;
 
@@ -47,7 +89,7 @@ public class QuickSort
     }
   }
 
-  public static void sort(float[] arr, int p, int r, Object[] s)
+  static void sort(float[] arr, int p, int r, Object[] s)
   {
     int q;
 
@@ -58,7 +100,8 @@ public class QuickSort
       sort(arr, q + 1, r, s);
     }
   }
-  public static void sort(double[] arr, int p, int r, Object[] s)
+
+  static void sort(double[] arr, int p, int r, Object[] s)
   {
     int q;
 
@@ -70,7 +113,19 @@ public class QuickSort
     }
   }
 
-  private static int partition(float[] arr, int p, int r, Object[] s)
+  static void sort(int[] arr, int p, int r, Object[] s)
+  {
+    int q;
+
+    if (p < r)
+    {
+      q = partition(arr, p, r, s);
+      sort(arr, p, q, s);
+      sort(arr, q + 1, r, s);
+    }
+  }
+
+  static int partition(float[] arr, int p, int r, Object[] s)
   {
     float x = arr[p];
     int i = p - 1;
@@ -81,14 +136,12 @@ public class QuickSort
       do
       {
         j = j - 1;
-      }
-      while (arr[j] > x);
+      } while (arr[j] > x);
 
       do
       {
         i = i + 1;
-      }
-      while (arr[i] < x);
+      } while (arr[i] < x);
 
       if (i < j)
       {
@@ -107,9 +160,9 @@ public class QuickSort
     }
   }
 
-  private static int partition(double[] arr, int p, int r, Object[] s)
+  static int partition(int[] arr, int p, int r, Object[] s)
   {
-    double x = arr[p];
+    int x = arr[p];
     int i = p - 1;
     int j = r + 1;
 
@@ -118,14 +171,47 @@ public class QuickSort
       do
       {
         j = j - 1;
-      }
-      while (arr[j] > x);
+      } while (arr[j] > x);
 
       do
       {
         i = i + 1;
+      } while (arr[i] < x);
+
+      if (i < j)
+      {
+        int tmp = arr[i];
+        arr[i] = arr[j];
+        arr[j] = tmp;
+
+        Object tmp2 = s[i];
+        s[i] = s[j];
+        s[j] = tmp2;
       }
-      while (arr[i] < x);
+      else
+      {
+        return j;
+      }
+    }
+  }
+
+  static int partition(double[] arr, int p, int r, Object[] s)
+  {
+    double x = arr[p];
+    int i = p - 1;
+    int j = r + 1;
+
+    while (true)
+    {
+      do
+      {
+        j = j - 1;
+      } while (arr[j] > x);
+
+      do
+      {
+        i = i + 1;
+      } while (arr[i] < x);
 
       if (i < j)
       {
@@ -144,7 +230,7 @@ public class QuickSort
     }
   }
 
-  private static int stringPartition(String[] arr, int p, int r, Object[] s)
+  static int stringPartition(String[] arr, int p, int r, Object[] s)
   {
     String x = arr[p];
     int i = p - 1;
@@ -155,14 +241,12 @@ public class QuickSort
       do
       {
         j = j - 1;
-      }
-      while (arr[j].compareTo(x) < 0);
+      } while (arr[j].compareTo(x) < 0);
 
       do
       {
         i = i + 1;
-      }
-      while (arr[i].compareTo(x) > 0);
+      } while (arr[i].compareTo(x) > 0);
 
       if (i < j)
       {