picrate 0.5.0-java → 0.6.0-java

data/src/main/java/processing/data/IntDict.java

@@ -19,14 +19,23 @@ public class IntDict {
   /** Number of elements in the table */
   protected int count;
 
-  protected String[] keys;
-  protected int[] values;
+    /**
+     *
+     */
+    protected String[] keys;
+
+    /**
+     *
+     */
+    protected int[] values;
 
   /** Internal implementation for faster lookups */
   private HashMap<String, Integer> indices = new HashMap<>();
 
-
-  public IntDict() {
+    /**
+     *
+     */
+    public IntDict() {
     count = 0;
     keys = new String[10];
     values = new int[10];
@@ -34,9 +43,10 @@ public class IntDict {
 
 
   /**
-   * 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 IntDict(int length) {
@@ -50,6 +60,7 @@ public class IntDict {
    * 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 IntDict(BufferedReader reader) {
@@ -69,6 +80,8 @@ public class IntDict {
   }
 
   /**
+     * @param keys
+     * @param values
    * @nowebref
    */
   public IntDict(String[] keys, int[] values) {
@@ -92,6 +105,7 @@ public class IntDict {
    *   { "key2", 2 }
    * });
    * </pre>
+     * @param pairs
    */
   public IntDict(Object[][] pairs) {
     count = pairs.length;
@@ -108,6 +122,7 @@ public class IntDict {
   /**
    * Returns the number of key/value pairs
    *
+     * @return 
    * @webref intdict:method
    * @brief Returns the number of key/value pairs
    */
@@ -117,8 +132,8 @@ public class IntDict {
 
 
   /**
-   * 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 arg0
    */
   public void resize(int length) {
     if (length > count) {
@@ -161,10 +176,22 @@ public class IntDict {
 
   // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
+    /**
+     *
+     */
+
 
   public class Entry {
-    public String key;
-    public int value;
+
+      /**
+       *
+       */
+      public String key;
+
+      /**
+       *
+       */
+      public int value;
 
     Entry(String key, int value) {
       this.key = key;
@@ -172,8 +199,11 @@ public class IntDict {
     }
   }
 
-
-  public Iterable<Entry> entries() {
+    /**
+     *
+     * @return
+     */
+    public Iterable<Entry> entries() {
     return new Iterable<Entry>() {
 
       public Iterator<Entry> iterator() {
@@ -182,8 +212,11 @@ public class IntDict {
     };
   }
 
-
-  public Iterator<Entry> entryIterator() {
+    /**
+     *
+     * @return
+     */
+    public Iterator<Entry> entryIterator() {
     return new Iterator<Entry>() {
       int index = -1;
 
@@ -207,21 +240,32 @@ public class IntDict {
 
   // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
+    /**
+     *
+     * @param index
+     * @return
+     */
+
 
   public String key(int index) {
     return keys[index];
   }
 
-
-  protected void crop() {
+    /**
+     *
+     */
+    protected void crop() {
     if (count != keys.length) {
       keys = PApplet.subset(keys, 0, count);
       values = PApplet.subset(values, 0, count);
     }
   }
 
-
-  public Iterable<String> keys() {
+    /**
+     *
+     * @return
+     */
+    public Iterable<String> keys() {
     return new Iterable<String>() {
 
       @Override
@@ -233,6 +277,11 @@ public class IntDict {
 
 
   // Use this to iterate when you want to be able to remove elements along the way
+
+    /**
+     *
+     * @return
+     */
   public Iterator<String> keyIterator() {
     return new Iterator<String>() {
       int index = -1;
@@ -254,8 +303,9 @@ public class IntDict {
 
 
   /**
-   * 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 intdict:method
    * @brief Return a copy of the internal keys array
    */
@@ -264,8 +314,12 @@ public class IntDict {
     return keyArray(null);
   }
 
-
-  public String[] keyArray(String[] outgoing) {
+    /**
+     *
+     * @param outgoing
+     * @return
+     */
+    public String[] keyArray(String[] outgoing) {
     if (outgoing == null || outgoing.length != count) {
       outgoing = new String[count];
     }
@@ -273,13 +327,18 @@ public class IntDict {
     return outgoing;
   }
 
-
-  public int value(int index) {
+    /**
+     *
+     * @param index
+     * @return
+     */
+    public int value(int index) {
     return values[index];
   }
 
 
   /**
+     * @return 
    * @webref intdict:method
    * @brief Return the internal array being used to store the values
    */
@@ -293,8 +352,11 @@ public class IntDict {
     };
   }
 
-
-  public Iterator<Integer> valueIterator() {
+    /**
+     *
+     * @return
+     */
+    public Iterator<Integer> valueIterator() {
     return new Iterator<Integer>() {
       int index = -1;
 
@@ -317,6 +379,7 @@ public class IntDict {
   /**
    * Create a new array and copy each of the values into it.
    *
+     * @return 
    * @webref intdict:method
    * @brief Create a new array and copy each of the values into it
    */
@@ -328,10 +391,11 @@ public class IntDict {
 
   /**
    * 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
-   * size as the number of values, a new array will be allocated and returned.
+   * 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 values to copy into the array
+     * @return 
    */
   public int[] valueArray(int[] array) {
     if (array == null || array.length != size()) {
@@ -345,6 +409,8 @@ public class IntDict {
   /**
    * Return a value for the specified key.
    *
+     * @param key
+     * @return 
    * @webref intdict:method
    * @brief Return a value for the specified key
    */
@@ -356,8 +422,13 @@ public class IntDict {
     return values[index];
   }
 
-
-  public int get(String key, int alternate) {
+    /**
+     *
+     * @param key
+     * @param alternate
+     * @return
+     */
+    public int get(String key, int alternate) {
     int index = index(key);
     if (index == -1) return alternate;
     return values[index];
@@ -367,6 +438,8 @@ public class IntDict {
   /**
    * Create a new key/value pair or change the value of one.
    *
+     * @param key
+     * @param amount
    * @webref intdict:method
    * @brief Create a new key/value pair or change the value of one
    */
@@ -379,8 +452,13 @@ public class IntDict {
     }
   }
 
-
-  public void setIndex(int index, String key, int value) {
+    /**
+     *
+     * @param index
+     * @param key
+     * @param value
+     */
+    public void setIndex(int index, String key, int value) {
     if (index < 0 || index >= count) {
       throw new ArrayIndexOutOfBoundsException(index);
     }
@@ -390,6 +468,8 @@ public class IntDict {
 
 
   /**
+     * @param key
+     * @return 
    * @webref intdict:method
    * @brief Check if a key is a part of the data structure
    */
@@ -401,6 +481,7 @@ public class IntDict {
   /**
    * Increase the value associated with a specific key by 1.
    *
+     * @param key
    * @webref intdict:method
    * @brief Increase the value of a specific key value by 1
    */
@@ -410,9 +491,10 @@ public class IntDict {
 
 
   /**
-   * Merge another dictionary into this one. Calling this increment()
-   * since it doesn't make sense in practice for the other dictionary types,
-   * even though it's technically an add().
+   * Merge another dictionary into this one.Calling this increment()
+ since it doesn't make sense in practice for the other dictionary types,
+ even though it's technically an add().
+     * @param arg0
    */
   public void increment(IntDict dict) {
     for (int i = 0; i < dict.count; i++) {
@@ -422,6 +504,8 @@ public class IntDict {
 
 
   /**
+     * @param key
+     * @param amount
    * @webref intdict:method
    * @brief Add to a value
    */
@@ -436,6 +520,8 @@ public class IntDict {
 
 
   /**
+     * @param key
+     * @param amount
    * @webref intdict:method
    * @brief Subtract from a value
    */
@@ -445,6 +531,8 @@ public class IntDict {
 
 
   /**
+     * @param key
+     * @param amount
    * @webref intdict:method
    * @brief Multiply a value
    */
@@ -457,6 +545,8 @@ public class IntDict {
 
 
   /**
+     * @param key
+     * @param amount
    * @webref intdict:method
    * @brief Divide a value
    */
@@ -479,6 +569,11 @@ public class IntDict {
 
 
   // return the index of the minimum value
+
+    /**
+     *
+     * @return
+     */
   public int minIndex() {
     //checkMinMax("minIndex");
     if (count == 0) return -1;
@@ -496,6 +591,11 @@ public class IntDict {
 
 
   // return the key for the minimum value
+
+    /**
+     *
+     * @return
+     */
   public String minKey() {
     checkMinMax("minKey");
     int index = minIndex();
@@ -507,6 +607,11 @@ public class IntDict {
 
 
   // return the minimum value, or throw an error if there are no values
+
+    /**
+     *
+     * @return
+     */
   public int minValue() {
     checkMinMax("minValue");
     return values[minIndex()];
@@ -514,6 +619,11 @@ public class IntDict {
 
 
   // return the index of the max value
+
+    /**
+     *
+     * @return
+     */
   public int maxIndex() {
     //checkMinMax("maxIndex");
     if (count == 0) {
@@ -531,7 +641,8 @@ public class IntDict {
   }
 
 
-  /** return the key corresponding to the maximum value or null if no entries */
+  /** return the key corresponding to the maximum value or null if no entries
+     * @return  */
   public String maxKey() {
     //checkMinMax("maxKey");
     int index = maxIndex();
@@ -543,13 +654,21 @@ public class IntDict {
 
 
   // return the maximum value or throw an error if zero length
+
+    /**
+     *
+     * @return
+     */
   public int maxValue() {
     checkMinMax("maxIndex");
     return values[maxIndex()];
   }
 
-
-  public int sum() {
+    /**
+     *
+     * @return
+     */
+    public int sum() {
     long amount = sumLong();
     if (amount > Integer.MAX_VALUE) {
       throw new RuntimeException("sum() exceeds " + Integer.MAX_VALUE + ", use sumLong()");
@@ -560,8 +679,11 @@ public class IntDict {
     return (int) amount;
   }
 
-
-  public long sumLong() {
+    /**
+     *
+     * @return
+     */
+    public long sumLong() {
     long sum = 0;
     for (int i = 0; i < count; i++) {
       sum += values[i];
@@ -569,14 +691,22 @@ public class IntDict {
     return sum;
   }
 
-
-  public int index(String what) {
+    /**
+     *
+     * @param what
+     * @return
+     */
+    public int index(String what) {
     Integer found = indices.get(what);
     return (found == null) ? -1 : found.intValue();
   }
 
-
-  protected void create(String what, int much) {
+    /**
+     *
+     * @param what
+     * @param much
+     */
+    protected void create(String what, int much) {
     if (count == keys.length) {
       keys = PApplet.expand(keys);
       values = PApplet.expand(values);
@@ -588,6 +718,8 @@ public class IntDict {
   }
 
   /**
+     * @param key
+     * @return 
    * @webref intdict:method
    * @brief Remove a key/value pair
    */
@@ -599,8 +731,12 @@ public class IntDict {
     return index;
   }
 
-
-  public String removeIndex(int index) {
+    /**
+     *
+     * @param index
+     * @return
+     */
+    public String removeIndex(int index) {
     if (index < 0 || index >= count) {
       throw new ArrayIndexOutOfBoundsException(index);
     }
@@ -618,8 +754,12 @@ public class IntDict {
     return key;
   }
 
-
-  public void swap(int a, int b) {
+    /**
+     *
+     * @param a
+     * @param b
+     */
+    public void swap(int a, int b) {
     String tkey = keys[a];
     int tvalue = values[a];
     keys[a] = keys[b];
@@ -686,13 +826,21 @@ public class IntDict {
     sortValuesReverse(true);
   }
 
-
-  public void sortValuesReverse(boolean stable) {
+    /**
+     *
+     * @param stable
+     */
+    public void sortValuesReverse(boolean stable) {
     sortImpl(false, true, stable);
   }
 
-
-  protected void sortImpl(final boolean useKeys, final boolean reverse,
+    /**
+     *
+     * @param useKeys
+     * @param reverse
+     * @param stable
+     */
+    protected void sortImpl(final boolean useKeys, final boolean reverse,
                           final boolean stable) {
     Sort s = new Sort() {
       @Override
@@ -745,7 +893,8 @@ public class IntDict {
   }
 
 
-  /** Returns a duplicate copy of this object. */
+  /** Returns a duplicate copy of this object.
+     * @return  */
   public IntDict copy() {
     IntDict outgoing = new IntDict(count);
     System.arraycopy(keys, 0, outgoing.keys, 0, count);
@@ -757,8 +906,10 @@ public class IntDict {
     return outgoing;
   }
 
-
-  public void print() {
+    /**
+     *
+     */
+    public void print() {
     for (int i = 0; i < size(); i++) {
       System.out.println(keys[i] + " = " + values[i]);
     }
@@ -779,6 +930,7 @@ public class IntDict {
 
   /**
    * Return this dictionary as a String in JSON format.
+     * @return 
    */
   public String toJSON() {
     StringList items = new StringList();
@@ -788,8 +940,11 @@ public class IntDict {
     return "{ " + items.join(", ") + " }";
   }
 
-
-  @Override
+    /**
+     *
+     * @return
+     */
+    @Override
   public String toString() {
     return getClass().getSimpleName() + " size=" + size() + " " + toJSON();
   }