An assortment of changes/new things

1 files changed, 50 insertions, 52 deletions

diff --git a/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java b/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
index 8d51996..ea67295 100644
--- a/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
+++ b/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
@@ -3,7 +3,7 @@ package bjc.utils.funcutils;
 import java.util.*;
 import java.util.function.*;
 
-import bjc.data.ArrayIterator;
+import bjc.data.*;
 
 /**
  * Utility methods for dealing with iterators.
@@ -13,57 +13,9 @@ import bjc.data.ArrayIterator;
  */
 public class IteratorUtils {
 	/**
-	 * A chain iterator. This is essentially flatMap in iterator form.
-	 * 
-	 * @author bjculkin
-	 *
-	 * @param <T1>
-	 *             The type of the input values.
-	 *
-	 * @param <T2>
-	 *             The type of the output values.
-	 */
-	public static class ChainIterator<T1, T2> implements Iterator<T2> {
-		private Iterator<T1> mainItr;
-		private Function<T1, Iterator<T2>> trans;
-
-		private Iterator<T2> curItr;
-
-		/**
-		 * Create a new chain iterator.
-		 *
-		 * @param mainItr
-		 *                The main iterator for input.
-		 *
-		 * @param trans
-		 *                The transformation to use to produce the outputs.
-		 */
-		public ChainIterator(Iterator<T1> mainItr, Function<T1, Iterator<T2>> trans) {
-			this.mainItr = mainItr;
-			this.trans = trans;
-		}
-
-		@Override
-		public boolean hasNext() {
-			if (curItr != null) {
-				return curItr.hasNext() ? true : mainItr.hasNext();
-			}
-
-			return mainItr.hasNext();
-		}
-
-		@Override
-		public T2 next() {
-			if (curItr == null || !curItr.hasNext()) {
-				curItr = trans.apply(mainItr.next());
-			}
-
-			return curItr.next();
-		}
-	}
-
-	/**
 	 * Convert an iterator to an iterable.
+	 * 
+	 * @param <E> The type being iterated over.
 	 *
 	 * @param itr
 	 *            The iterator to convert.
@@ -77,6 +29,8 @@ public class IteratorUtils {
 	/**
 	 * Convert an iterable to an iterator.
 	 *
+	 * @param <E> The type being iterated over.
+	 * 
 	 * @param itr
 	 *            The iterable to convert.
 	 *
@@ -89,18 +43,23 @@ public class IteratorUtils {
 	/**
 	 * Convert an array to an iterator.
 	 *
+	 * @param <E> The type being iterated over.
+	 * 
 	 * @param parms
 	 *              The array to iterate over.
 	 *
 	 * @return An iterator over the provided array.
 	 */
 	@SafeVarargs
-	public static <E> Iterator<E> AI(E... parms) {
+	public static <E> Iterator<E> I(E... parms) {
 		return new ArrayIterator<>(parms);
 	}
 
 	/**
 	 * Create a chain iterator.
+	 * 
+	 * @param <A> The initial type being iterated over.
+	 * @param <B> The resulting type being iterated over.
 	 *
 	 * @param itrA
 	 *             The iterator for input values.
@@ -114,4 +73,43 @@ public class IteratorUtils {
 			Function<A, Iterator<B>> itrB) {
 		return new ChainIterator<>(itrA, itrB);
 	}
+	
+	/**
+	 * Perform a left-fold over an iterator.
+	 * 
+	 * @param <ElementType> The type of elements in the iterator.
+	 * @param <ResultType> The result from the fold.
+	 * 
+	 * @param itr The items to iterate over.
+	 * @param zero The initial element for the fold.
+	 * @param folder The function that does the folding.
+	 * 
+	 * @return The result of folding over the iterator.
+	 */
+	public static <ElementType, ResultType> ResultType foldLeft(
+			Iterable<ElementType> itr,
+			ResultType zero,
+			BiFunction<ElementType, ResultType, ResultType> folder)
+	{
+		ResultType state = zero;
+		for (ElementType elem : itr) {
+			state = folder.apply(elem, state);
+		}
+		return state;
+	}
+	
+	/**
+	 * Creates an 'entangled' pair of a consumer and an iterator.
+	 * 
+	 * @param <ElementType> The type of value involved.
+	 * 
+	 * @return A pair consisting of a consumer of values, and an iterator that
+	 *         yields the consumed values.
+	 */
+	public static <ElementType>
+	IPair<Consumer<ElementType>, Iterator<ElementType>> entangle()
+	{
+		Queue<ElementType> backer = new ArrayDeque<>();
+		return IPair.pair(backer::add, new QueueBackedIterator<>(backer));
+	}
 }