propane 3.11.0-java → 4.0.0-java

data/src/main/java/processing/core/PMatrix.java

@@ -43,18 +43,21 @@ public interface PMatrix {
   
   /**
    * Returns a copy of this PMatrix.
+     * @return 
    */
   public PMatrix get();  
 
   /**
-   * Copies the matrix contents into a float array.
-   * If target is null (or not the correct size), a new array will be created.
+   * Copies the matrix contents into a float array.If target is null (or not the correct size), a new array will be created.
+     * @param target
+     * @return 
    */
   public float[] get(float[] target);
   
   
   /**
    * Make this matrix become a copy of src.
+     * @param src
    */
   public void set(PMatrix src);
 

data/src/main/java/processing/data/DoubleDict.java

@@ -1,6 +1,9 @@
 package processing.data;
 
-import java.io.*;
+//import java.io.*;
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.PrintWriter;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
@@ -36,9 +39,10 @@ public class DoubleDict {
 
 
   /**
-   * Create a new lookup with a specific size. This is more efficient than not
-   * specifying a size. Use it when you know the rough size of the thing you're creating.
+   * Create a new lookup with a specific size.This is more efficient than not
+ specifying a size. Use it when you know the rough size of the thing you're creating.
    *
+   * @param length
    * @nowebref
    */
   public DoubleDict(int length) {
@@ -52,6 +56,7 @@ public class DoubleDict {
    * Read a set of entries from a Reader that has each key/value pair on
    * a single line, separated by a tab.
    *
+   * @param reader
    * @nowebref
    */
   public DoubleDict(BufferedReader reader) {
@@ -59,19 +64,21 @@ public class DoubleDict {
     keys = new String[lines.length];
     values = new double[lines.length];
 
-    for (int i = 0; i < lines.length; i++) {
-      String[] pieces = PApplet.split(lines[i], '\t');
-      if (pieces.length == 2) {
-        keys[count] = pieces[0];
-        values[count] = PApplet.parseFloat(pieces[1]);
-        indices.put(pieces[0], count);
-        count++;
+      for (String line : lines) {
+          String[] pieces = PApplet.split(line, '\t');
+          if (pieces.length == 2) {
+              keys[count] = pieces[0];
+              values[count] = PApplet.parseFloat(pieces[1]);
+              indices.put(pieces[0], count);
+              count++;
+          }
       }
-    }
   }
 
 
   /**
+   * @param keys
+   * @param values
    * @nowebref
    */
   public DoubleDict(String[] keys, double[] values) {
@@ -95,6 +102,7 @@ public class DoubleDict {
    *   { "key2", 2 }
    * });
    * </pre>
+   * @param pairs
    */
   public DoubleDict(Object[][] pairs) {
     count = pairs.length;
@@ -123,6 +131,7 @@ public class DoubleDict {
 
 
   /**
+   * @return 
    * @webref doubledict:method
    * @brief Returns the number of key/value pairs
    */
@@ -132,8 +141,8 @@ public class DoubleDict {
 
 
   /**
-   * Resize the internal data, this can only be used to shrink the list.
-   * Helpful for situations like sorting and then grabbing the top 50 entries.
+   * Resize the internal data, this can only be used to shrink the list.Helpful for situations like sorting and then grabbing the top 50 entries.
+   * @param length
    */
   public void resize(int length) {
     if (length == count) return;
@@ -191,12 +200,7 @@ public class DoubleDict {
 
 
   public Iterable<Entry> entries() {
-    return new Iterable<Entry>() {
-
-      public Iterator<Entry> iterator() {
-        return entryIterator();
-      }
-    };
+    return this::entryIterator;
   }
 
 
@@ -204,17 +208,20 @@ public class DoubleDict {
     return new Iterator<Entry>() {
       int index = -1;
 
+      @Override
       public void remove() {
         removeIndex(index);
         index--;
       }
 
+      @Override
       public Entry next() {
         ++index;
         Entry e = new Entry(keys[index], values[index]);
         return e;
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < size();
       }
@@ -239,13 +246,7 @@ public class DoubleDict {
 
 
   public Iterable<String> keys() {
-    return new Iterable<String>() {
-
-      @Override
-      public Iterator<String> iterator() {
-        return keyIterator();
-      }
-    };
+    return this::keyIterator;
   }
 
 
@@ -254,15 +255,18 @@ public class DoubleDict {
     return new Iterator<String>() {
       int index = -1;
 
+      @Override
       public void remove() {
         removeIndex(index);
         index--;
       }
 
+      @Override
       public String next() {
         return key(++index);
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < size();
       }
@@ -271,8 +275,9 @@ public class DoubleDict {
 
 
   /**
-   * Return a copy of the internal keys array. This array can be modified.
+   * Return a copy of the internal keys array.This array can be modified.
    *
+   * @return 
    * @webref doubledict:method
    * @brief Return a copy of the internal keys array
    */
@@ -297,17 +302,12 @@ public class DoubleDict {
 
 
   /**
+     * @return 
    * @webref doubledict:method
    * @brief Return the internal array being used to store the values
    */
   public Iterable<Double> values() {
-    return new Iterable<Double>() {
-
-      @Override
-      public Iterator<Double> iterator() {
-        return valueIterator();
-      }
-    };
+    return () -> valueIterator();
   }
 
 
@@ -315,15 +315,18 @@ public class DoubleDict {
     return new Iterator<Double>() {
       int index = -1;
 
+      @Override
       public void remove() {
         removeIndex(index);
         index--;
       }
 
+      @Override
       public Double next() {
         return value(++index);
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < size();
       }
@@ -334,6 +337,7 @@ public class DoubleDict {
   /**
    * Create a new array and copy each of the values into it.
    *
+   * @return 
    * @webref doubledict:method
    * @brief Create a new array and copy each of the values into it
    */
@@ -345,8 +349,10 @@ public class DoubleDict {
 
   /**
    * Fill an already-allocated array with the values (more efficient than
-   * creating a new array each time). If 'array' is null, or not the same
+   * creating a new array each time).If 'array' is null, or not the same
    * size as the number of values, a new array will be allocated and returned.
+   * @param array
+   * @return 
    */
   public double[] valueArray(double[] array) {
     if (array == null || array.length != size()) {
@@ -360,6 +366,8 @@ public class DoubleDict {
   /**
    * Return a value for the specified key.
    *
+   * @param key
+   * @return 
    * @webref doubledict:method
    * @brief Return a value for the specified key
    */
@@ -382,6 +390,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref doubledict:method
    * @brief Create a new key/value pair or change the value of one
    */
@@ -405,6 +415,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @return 
    * @webref doubledict:method
    * @brief Check if a key is a part of the data structure
    */
@@ -414,6 +426,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref doubledict:method
    * @brief Add to a value
    */
@@ -428,6 +442,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref doubledict:method
    * @brief Subtract from a value
    */
@@ -437,6 +453,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref doubledict:method
    * @brief Multiply a value
    */
@@ -449,6 +467,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref doubledict:method
    * @brief Divide a value
    */
@@ -471,6 +491,7 @@ public class DoubleDict {
 
 
   /**
+   * @return 
    * @webref doublelist:method
    * @brief Return the smallest value
    */
@@ -525,6 +546,7 @@ public class DoubleDict {
 
 
   /**
+   * @return 
    * @webref doublelist:method
    * @brief Return the largest value
    */
@@ -558,7 +580,8 @@ public class DoubleDict {
   }
 
 
-  /** The key for a max value; null if empty or everything is NaN (no max). */
+  /** The key for a max value; null if empty or everything is NaN (no max).
+   * @return  */
   public String maxKey() {
     //checkMinMax("maxKey");
     int index = maxIndex();
@@ -569,7 +592,8 @@ public class DoubleDict {
   }
 
 
-  /** The max value. (Or NaN if no entries or they're all NaN.) */
+  /** *  The max value.(Or NaN if no entries or they're all NaN.)
+   * @return  */
   public double maxValue() {
     //checkMinMax("maxValue");
     int index = maxIndex();
@@ -591,7 +615,7 @@ public class DoubleDict {
 
   public int index(String what) {
     Integer found = indices.get(what);
-    return (found == null) ? -1 : found.intValue();
+    return (found == null) ? -1 : found;
   }
 
 
@@ -600,7 +624,7 @@ public class DoubleDict {
       keys = PApplet.expand(keys);
       values = PApplet.expand(values);
     }
-    indices.put(what, Integer.valueOf(count));
+    indices.put(what, count);
     keys[count] = what;
     values[count] = much;
     count++;
@@ -608,6 +632,8 @@ public class DoubleDict {
 
 
   /**
+   * @param key
+   * @return 
    * @webref doubledict:method
    * @brief Remove a key/value pair
    */
@@ -789,7 +815,8 @@ public class DoubleDict {
   }
 
 
-  /** Returns a duplicate copy of this object. */
+  /** Returns a duplicate copy of this object.
+   * @return  */
   public DoubleDict copy() {
     DoubleDict outgoing = new DoubleDict(count);
     System.arraycopy(keys, 0, outgoing.keys, 0, count);
@@ -811,11 +838,12 @@ public class DoubleDict {
 
   /**
    * Save tab-delimited entries to a file (TSV format, UTF-8 encoding)
+   * @param file
    */
   public void save(File file) {
-    PrintWriter writer = PApplet.createWriter(file);
-    write(writer);
-    writer.close();
+      try (PrintWriter writer = PApplet.createWriter(file)) {
+          write(writer);
+      }
   }
 
 
@@ -833,6 +861,7 @@ public class DoubleDict {
 
   /**
    * Return this dictionary as a String in JSON format.
+   * @return 
    */
   public String toJSON() {
     StringList items = new StringList();

data/src/main/java/processing/data/DoubleList.java

@@ -32,6 +32,7 @@ public class DoubleList implements Iterable<Double> {
 
 
   /**
+   * @param length
    * @nowebref
    */
   public DoubleList(int length) {
@@ -40,6 +41,7 @@ public class DoubleList implements Iterable<Double> {
 
 
   /**
+   * @param list
    * @nowebref
    */
   public DoubleList(double[] list) {
@@ -50,9 +52,9 @@ public class DoubleList implements Iterable<Double> {
 
 
   /**
-   * Construct an FloatList from an iterable pile of objects.
-   * For instance, a double array, an array of strings, who knows).
+   * Construct an FloatList from an iterable pile of objects.For instance, a double array, an array of strings, who knows).
    * Un-parseable or null values will be set to NaN.
+     * @param iter
    * @nowebref
    */
   public DoubleList(Iterable<Object> iter) {
@@ -904,6 +906,7 @@ public class DoubleList implements Iterable<Double> {
 
   /**
    * Write entries to a PrintWriter, one per line
+     * @param writer
    */
   public void write(PrintWriter writer) {
     for (int i = 0; i < count; i++) {
@@ -915,6 +918,7 @@ public class DoubleList implements Iterable<Double> {
 
   /**
    * Return this dictionary as a String in JSON format.
+   * @return 
    */
   public String toJSON() {
     return "[ " + join(", ") + " ]";