Reference additions for Lists and Dicts

REAS · REAS · commit 467c0dd4a272 · 2013-05-28T11:55:47.000-07:00
diff --git a/content/api_en/FloatDict_keys.xml b/content/api_en/FloatDict_keys.xml
@@ -21,17 +21,16 @@ void setup() {
   size(200, 200);
   inventory = new FloatDict(goods, amounts);
   println(inventory); 
-  String[] theKeys = inventory.keys();
-  println(theKeys);
+  for (String k : inventory.keys()) {
+    println(k);
+  }
 }
 
 ]]></code>
 </example>
 
 <description><![CDATA[
-Return the internal array being used to store the keys. Allocated 
-but unused entries will be removed. In contrast to the <b>keyArray()</b> 
-method, this array should not be modified.
+Return the internal array being used to store the keys.
 ]]></description>
 
 </root>
diff --git a/content/api_en/FloatDict_values.xml b/content/api_en/FloatDict_values.xml
@@ -12,12 +12,25 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+String[] goods = { "coffee", "flour", "tea"};
+float[] amounts = { 108.6, 5.8, 8.2 };
+
+FloatDict inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatDict(goods, amounts);
+  println(inventory); 
+  for (float f : inventory.values()) {
+    println(f);
+  }
+}
+
 ]]></code>
 </example>
 
 <description><![CDATA[
-To come...
+Return the internal array being used to store the values.
 ]]></description>
 
 </root>
diff --git a/content/api_en/FloatList.xml b/content/api_en/FloatList.xml
@@ -33,7 +33,12 @@ void draw() {
 </example>
 
 <description><![CDATA[
-Helper class for a list of Floats. By design (for efficiency), functions like <b>sort()</b> and <b>shuffle()</b> always act on the list itself. To get a sorted copy, use list.copy().sort(). There are more methods listed in the Processing JavaDoc.
+Helper class for a list of floats. Lists are designed to have some of the 
+features of ArrayLists, but to maintain the simplicity and efficiency of
+working with arrays. <br />
+<br />
+Functions like sort() and shuffle() always act on the list itself. To get 
+a sorted copy, use list.copy().sort().
 ]]></description>
 
 
diff --git a/content/api_en/FloatList_add.xml b/content/api_en/FloatList_add.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.add(2, 2.4);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_append.xml b/content/api_en/FloatList_append.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.append(3.14);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_array.xml b/content/api_en/FloatList_array.xml
@@ -12,7 +12,18 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.sort();
+  float[] sortedInventory = inventory.array();
+  println(sortedInventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_clear.xml b/content/api_en/FloatList_clear.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.clear();
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_div.xml b/content/api_en/FloatList_div.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.div(0, 2);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_hasValue.xml b/content/api_en/FloatList_hasValue.xml
@@ -12,7 +12,20 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  if (inventory.hasValue(5.8) == true) {
+    println("Yes, we have a '5.8'"); 
+  } else {
+    println("Sorry, no '5.8'");
+  }
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_max.xml b/content/api_en/FloatList_max.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  float largest = inventory.max();
+  println(largest);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_min.xml b/content/api_en/FloatList_min.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  float smallest = inventory.min();
+  println(smallest);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_mult.xml b/content/api_en/FloatList_mult.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.mult(1, 4);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_remove.xml b/content/api_en/FloatList_remove.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.remove(1);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_reverse.xml b/content/api_en/FloatList_reverse.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.reverse();
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_set.xml b/content/api_en/FloatList_set.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.set(2, 20.6);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_shuffle.xml b/content/api_en/FloatList_shuffle.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.shuffle();
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_sort.xml b/content/api_en/FloatList_sort.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.sort();
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/FloatList_sortReverse.xml b/content/api_en/FloatList_sortReverse.xml
@@ -17,7 +17,7 @@ To come...
 </example>
 
 <description><![CDATA[
-Reverse sort, orders values from highest to lowest.
+A sort in reverse. It's equivalent to running <b>sort()</b> and then <b>reverse()</b>, but is more efficient than running each separately.
 ]]></description>
 
 </root>
diff --git a/content/api_en/FloatList_sub.xml b/content/api_en/FloatList_sub.xml
@@ -12,7 +12,17 @@
 <example>
 <image></image>
 <code><![CDATA[
-To come...
+float[] numbers = { 108.6, 5.8, 8.2 };
+FloatList inventory;
+
+void setup() {
+  size(200, 200);
+  inventory = new FloatList(numbers);
+  println(inventory);
+  inventory.sub(2, 4.1);
+  println(inventory);
+}
+
 ]]></code>
 </example>
 
diff --git a/content/api_en/IntDict_keys.xml b/content/api_en/IntDict_keys.xml
@@ -21,17 +21,16 @@ void setup() {
   size(200, 200);
   inventory = new IntDict(goods, amounts);
   println(inventory); 
-  String[] theKeys = inventory.keys();
-  println(theKeys);
+  for (String k : inventory.keys()) {
+    println(k);
+  }
 }
 
 ]]></code>
 </example>
 
 <description><![CDATA[
-Return the internal array being used to store the keys. Allocated 
-but unused entries will be removed. In contrast to the <b>keyArray()</b> 
-method, this array should not be modified.
+Return the internal array being used to store the keys.
 ]]></description>
 
 </root>
diff --git a/content/api_en/IntDict_sortKeysReverse.xml b/content/api_en/IntDict_sortKeysReverse.xml
@@ -29,8 +29,8 @@ void setup() {
 </example>
 
 <description><![CDATA[
-Sort the keys alphabetically in reverse (ignoring case). Uses the value 
-as a tie-breaker (only really possible with a key that has a case change).
+Sort the keys alphabetically in reverse (ignoring case). Uses the value as 
+a tie-breaker (only really possible with a key that has a case change).
 ]]></description>
 
 </root>
diff --git a/content/api_en/IntDict_values.xml b/content/api_en/IntDict_values.xml
diff --git a/content/api_en/IntList.xml b/content/api_en/IntList.xml
diff --git a/content/api_en/IntList_sortReverse.xml b/content/api_en/IntList_sortReverse.xml
diff --git a/content/api_en/StringDict_keys.xml b/content/api_en/StringDict_keys.xml
diff --git a/content/api_en/StringDict_values.xml b/content/api_en/StringDict_values.xml
diff --git a/content/api_en/StringList.xml b/content/api_en/StringList.xml
diff --git a/content/api_en/StringList_remove.xml b/content/api_en/StringList_remove.xml
diff --git a/content/api_en/StringList_sortReverse.xml b/content/api_en/StringList_sortReverse.xml
