clean up LongList, array() change, bug fixes, remove comments and warnings

benfry · benfry · commit 9cffde66c283 · 2022-08-03T21:02:59.000-04:00
diff --git a/core/src/processing/data/LongList.java b/core/src/processing/data/LongList.java
@@ -15,12 +15,11 @@
 
 
 /**
- * Helper class for a list of ints. Lists are designed to have some of the
- * features of ArrayLists, but to maintain the simplicity and efficiency of
- * working with arrays.
- *
- * Functions like sort() and shuffle() always act on the list itself. To get
- * a sorted copy, use list.copy().sort().
+ * Helper class for a list of ints. Lists are designed to have
+ * some features of ArrayLists, but to maintain the simplicity and
+ * efficiency of working with arrays.
+ * Functions such as sort() and shuffle() always act on the list itself.
+ * To get a sorted copy, use list.copy().sort().
  *
  * @nowebref
  * @see FloatList
@@ -31,6 +30,7 @@ public class LongList implements Iterable<Long> {
   protected long[] data;
 
 
+  @SuppressWarnings("unused")
   public LongList() {
     data = new long[10];
   }
@@ -47,7 +47,7 @@ public LongList(int length) {
   /**
    * @nowebref
    */
-  public LongList(int[] source) {
+  public LongList(long[] source) {
     count = source.length;
     data = new long[count];
     System.arraycopy(source, 0, data, 0, count);
@@ -56,10 +56,11 @@ public LongList(int[] source) {
 
   /**
    * Construct an IntList from an iterable pile of objects.
-   * For instance, a float array, an array of strings, who knows).
-   * Un-parseable or null values will be set to 0.
+   * For instance, a float array, an array of strings, who knows.
+   * Un-parsable or null values will be set to 0.
    * @nowebref
    */
+  @SuppressWarnings("unused")
   public LongList(Iterable<Object> iter) {
     this(10);
     for (Object o : iter) {
@@ -77,28 +78,32 @@ public LongList(Iterable<Object> iter) {
 
   /**
    * Construct an IntList from a random pile of objects.
-   * Un-parseable or null values will be set to zero.
+   * Un-parsable or null values will be set to zero.
    */
+  @SuppressWarnings("unused")
   public LongList(Object... items) {
-    final int missingValue = 0;  // nuts, can't be last/final/second arg
+    final long missingValue = 0;  // nuts, can't be last/final/second arg
 
     count = items.length;
     data = new long[count];
     int index = 0;
     for (Object o : items) {
-      int value = missingValue;
+      long value = missingValue;
       if (o != null) {
         if (o instanceof Number) {
-          value = ((Number) o).intValue();
+          value = ((Number) o).longValue();
         } else {
-          value = PApplet.parseInt(o.toString().trim(), missingValue);
+          try {
+            value = Long.parseLong(o.toString().trim());
+          } catch (NumberFormatException ignored) { }
         }
       }
       data[index++] = value;
     }
   }
 
 
+  @SuppressWarnings("unused")
   static public LongList fromRange(int stop) {
     return fromRange(0, stop);
   }
@@ -240,6 +245,7 @@ public long remove(int index) {
 
   // Remove the first instance of a particular value,
   // and return the index at which it was found.
+  @SuppressWarnings("unused")
   public int removeValue(int value) {
     int index = index(value);
     if (index != -1) {
@@ -252,6 +258,7 @@ public int removeValue(int value) {
 
   // Remove all instances of a particular value,
   // and return the number of values found and removed
+  @SuppressWarnings("unused")
   public int removeValues(int value) {
     int ii = 0;
     for (int i = 0; i < count; i++) {
@@ -294,6 +301,7 @@ public void append(LongList list) {
 
 
   /** Add this value, but only if it's not already in the list. */
+  @SuppressWarnings("unused")
   public void appendUnique(int value) {
     if (!hasValue(value)) {
       append(value);
@@ -370,60 +378,8 @@ public void insert(int index, LongList list) {
   }
 
 
-    // below are aborted attempts at more optimized versions of the code
-    // that are harder to read and debug...
-
-//    if (index + values.length >= count) {
-//      // We're past the current 'count', check to see if we're still allocated
-//      // index 9, data.length = 10, values.length = 1
-//      if (index + values.length < data.length) {
-//        // There's still room for these entries, even though it's past 'count'.
-//        // First clear out the entries leading up to it, however.
-//        for (int i = count; i < index; i++) {
-//          data[i] = 0;
-//        }
-//        data[index] =
-//      }
-//      if (index >= data.length) {
-//        int length = index + values.length;
-//        int[] temp = new int[length];
-//        System.arraycopy(data, 0, temp, 0, count);
-//        System.arraycopy(values, 0, temp, index, values.length);
-//        data = temp;
-//        count = data.length;
-//      } else {
-//
-//      }
-//
-//    } else if (count == data.length) {
-//      int[] temp = new int[count << 1];
-//      System.arraycopy(data, 0, temp, 0, index);
-//      temp[index] = value;
-//      System.arraycopy(data, index, temp, index+1, count - index);
-//      data = temp;
-//
-//    } else {
-//      // data[] has room to grow
-//      // for() loop believed to be faster than System.arraycopy over itself
-//      for (int i = count; i > index; --i) {
-//        data[i] = data[i-1];
-//      }
-//      data[index] = value;
-//      count++;
-//    }
-
-
   /** Return the first index of a particular value. */
   public int index(int what) {
-    /*
-    if (indexCache != null) {
-      try {
-        return indexCache.get(what);
-      } catch (Exception e) {  // not there
-        return -1;
-      }
-    }
-    */
     for (int i = 0; i < count; i++) {
       if (data[i] == what) {
         return i;
@@ -433,26 +389,13 @@ public int index(int what) {
   }
 
 
-  // !!! TODO this is not yet correct, because it's not being reset when
-  // the rest of the entries are changed
-//  protected void cacheIndices() {
-//    indexCache = new HashMap<Integer, Integer>();
-//    for (int i = 0; i < count; i++) {
-//      indexCache.put(data[i], i);
-//    }
-//  }
-
   /**
    * Check if a number is a part of the list
    *
    * @webref intlist:method
    * @webBrief Check if a number is a part of the list
    */
   public boolean hasValue(int value) {
-//    if (indexCache == null) {
-//      cacheIndices();
-//    }
-//    return index(what) != -1;
     for (int i = 0; i < count; i++) {
       if (data[i] == value) {
         return true;
@@ -567,6 +510,7 @@ public long min() {
 
   // returns the index of the minimum value.
   // if there are ties, it returns the first one found.
+  @SuppressWarnings("unused")
   public int minIndex() {
     checkMinMax("minIndex");
     long value = data[0];
@@ -674,23 +618,6 @@ public void swap(int a, int b) {
   }
 
 
-  // use insert()
-//  public void splice(int index, int value) {
-//  }
-
-
-//  public void subset(int start) {
-//    subset(start, count - start);
-//  }
-//
-//
-//  public void subset(int start, int num) {
-//    for (int i = 0; i < num; i++) {
-//      data[i] = data[i+start];
-//    }
-//    count = num;
-//  }
-
   /**
    * Reverse the order of the list elements
    *
@@ -715,6 +642,7 @@ public void reverse() {
    * @webref intlist:method
    * @webBrief Randomize the order of the list elements
    */
+  @SuppressWarnings("unused")
   public void shuffle() {
     Random r = new Random();
     int num = count;
@@ -732,6 +660,7 @@ public void shuffle() {
    * Randomize the list order using the random() function from the specified
    * sketch, allowing shuffle() to use its current randomSeed() setting.
    */
+  @SuppressWarnings("unused")
   public void shuffle(PApplet sketch) {
     int num = count;
     while (num > 1) {
@@ -781,8 +710,7 @@ public long[] values() {
 
   @Override
   public Iterator<Long> iterator() {
-//  public Iterator<Integer> valueIterator() {
-    return new Iterator<Long>() {
+    return new Iterator<>() {
       int index = -1;
 
       public void remove() {
@@ -808,78 +736,35 @@ public boolean hasNext() {
    * @webref intlist:method
    * @webBrief Create a new array with a copy of all the values
    */
-  public int[] array() {
-    return array(null);
+  public long[] toArray() {
+    return toArray(null);
   }
 
 
   /**
-   * Copy values into the specified array. If the specified array is null or
-   * not the same size, a new array will be allocated.
-   * @param array
+   * Copy values into the specified array. If the specified array is
+   * null or not the same size, a new array will be allocated.
    */
-  public int[] array(int[] array) {
+  public long[] toArray(long[] array) {
     if (array == null || array.length != count) {
-      array = new int[count];
+      array = new long[count];
     }
     System.arraycopy(data, 0, array, 0, count);
     return array;
   }
 
 
-//  public int[] toIntArray() {
-//    int[] outgoing = new int[count];
-//    for (int i = 0; i < count; i++) {
-//      outgoing[i] = (int) data[i];
-//    }
-//    return outgoing;
-//  }
-
-
-//  public long[] toLongArray() {
-//    long[] outgoing = new long[count];
-//    for (int i = 0; i < count; i++) {
-//      outgoing[i] = (long) data[i];
-//    }
-//    return outgoing;
-//  }
-
-
-//  public float[] toFloatArray() {
-//    float[] outgoing = new float[count];
-//    System.arraycopy(data, 0, outgoing, 0, count);
-//    return outgoing;
-//  }
-
-
-//  public double[] toDoubleArray() {
-//    double[] outgoing = new double[count];
-//    for (int i = 0; i < count; i++) {
-//      outgoing[i] = data[i];
-//    }
-//    return outgoing;
-//  }
-
-
-//  public String[] toStringArray() {
-//    String[] outgoing = new String[count];
-//    for (int i = 0; i < count; i++) {
-//      outgoing[i] = String.valueOf(data[i]);
-//    }
-//    return outgoing;
-//  }
-
-
   /**
-   * Returns a normalized version of this array. Called getPercent() for
-   * consistency with the Dict classes. It's a getter method because it needs
-   * to returns a new list (because IntList/Dict can't do percentages or
-   * normalization in place on int values).
+   * Returns a normalized version of this array. Called getPercent()
+   * for consistency with the Dict classes. It's a get method because
+   * it needs to return a new list (because IntList/Dict can't do
+   * percentages or normalization in place on int values).
    */
+  @SuppressWarnings("unused")
   public FloatList getPercent() {
     double sum = 0;
-    for (float value : array()) {
-      sum += value;
+    for (int i = 0; i < count; i++) {
+      sum += data[i];
     }
     FloatList outgoing = new FloatList(count);
     for (int i = 0; i < count; i++) {
@@ -890,26 +775,14 @@ public FloatList getPercent() {
   }
 
 
-//  /**
-//   * Count the number of times each entry is found in this list.
-//   * Converts each entry to a String so it can be used as a key.
-//   */
-//  public IntDict getTally() {
-//    IntDict outgoing = new IntDict();
-//    for (int i = 0; i < count; i++) {
-//      outgoing.increment(String.valueOf(data[i]));
-//    }
-//    return outgoing;
-//  }
-
-
+  @SuppressWarnings("unused")
   public LongList getSubset(int start) {
     return getSubset(start, count - start);
   }
 
 
   public LongList getSubset(int start, int num) {
-    int[] subset = new int[num];
+    long[] subset = new long[num];
     System.arraycopy(data, start, subset, 0, num);
     return new LongList(subset);
   }
diff --git a/core/todo.txt b/core/todo.txt
@@ -8,6 +8,8 @@ X add toXxxxList() methods to JSONArray
 X rename getXxxArray() to toXxxArray() in JSONArray for consistency
 X   deprecate the old versions
 X add random() method to XxxList classes to return a random value from the list
+X use toArray() instead of array() in LongList
+X   did not deprecate old version because it was actually broken
 
 
 _ concurrent StringDict et al
