Update trees

1 files changed, 102 insertions, 65 deletions

diff --git a/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java b/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java
index 30d5558..2ccebae 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java
@@ -1,7 +1,7 @@
 package bjc.utils.data;
 
-import bjc.utils.funcdata.IList;
 import bjc.utils.funcdata.bst.TreeLinearizationMethod;
+import bjc.utils.functypes.ListFlattener;
 
 import java.util.function.Consumer;
 import java.util.function.Function;
@@ -9,11 +9,12 @@ import java.util.function.Predicate;
 import java.util.function.UnaryOperator;
 
 /**
- * A node in a homogeneous tree with a unlimited amount of children
+ * A node in a homogeneous tree with a unlimited amount of children.
  *
  * @author ben
+ * 
  * @param <ContainedType>
- *                The type of data contained in the tree nodes
+ *                The type of data contained in the tree nodes.
  *
  */
 public interface ITree<ContainedType> {
@@ -23,166 +24,202 @@ public interface ITree<ContainedType> {
 	 * @param child
 	 *                The child to append to this node.
 	 */
-	public void addChild(ITree<ContainedType> child);
+	void addChild(ITree<ContainedType> child);
 
 	/**
 	 * Prepend a child to this node.
 	 * 
-	 * @param child The child to prepend to this node.
+	 * @param child
+	 *                The child to prepend to this node.
 	 */
 	void prependChild(ITree<ContainedType> child);
-	
+
 	/**
-	 * Collapse a tree into a single version
+	 * Collapse a tree into a single version.
 	 *
 	 * @param <NewType>
-	 *                The intermediate type being folded
+	 *                The intermediate type being folded.
+	 * 
 	 * @param <ReturnedType>
-	 *                The type that is the end result
+	 *                The type that is the end result.
+	 * 
 	 * @param leafTransform
-	 *                The function to use to convert leaf values
+	 *                The function to use to convert leaf values.
+	 * 
 	 * @param nodeCollapser
 	 *                The function to use to convert internal nodes and
-	 *                their children
+	 *                their children.
+	 * 
 	 * @param resultTransformer
 	 *                The function to use to convert a state to the returned
-	 *                version
-	 * @return The final transformed state
+	 *                version.
+	 * 
+	 * @return The final transformed state.
 	 */
-	public <NewType, ReturnedType> ReturnedType collapse(Function<ContainedType, NewType> leafTransform,
-			Function<ContainedType, Function<IList<NewType>, NewType>> nodeCollapser,
+	<NewType, ReturnedType> ReturnedType collapse(Function<ContainedType, NewType> leafTransform,
+			Function<ContainedType, ListFlattener<NewType>> nodeCollapser,
 			Function<NewType, ReturnedType> resultTransformer);
 
 	/**
-	 * Execute a given action for each of this tree's children
+	 * Execute a given action for each of this tree's children.
 	 *
 	 * @param action
-	 *                The action to execute for each child
+	 *                The action to execute for each child.
 	 */
 	void doForChildren(Consumer<ITree<ContainedType>> action);
 
 	/**
 	 * Expand the nodes of a tree into trees, and then merge the contents of
-	 * those trees into a single tree
+	 * those trees into a single tree.
 	 *
 	 * @param mapper
-	 *                The function to use to map values into trees
-	 * @return A tree, with some nodes expanded into trees
+	 *                The function to use to map values into trees.
+	 * 
+	 * @return A tree, with some nodes expanded into trees.
 	 */
-	public ITree<ContainedType> flatMapTree(Function<ContainedType, ITree<ContainedType>> mapper);
+	default ITree<ContainedType> flatMapTree(Function<ContainedType, ITree<ContainedType>> mapper) {
+		return topDownTransform((dat) -> TopDownTransformResult.PUSHDOWN, (node) -> {
+			if (node.getChildrenCount() > 0) {
+				ITree<ContainedType> parent = node.transformHead(mapper);
+
+				node.doForChildren(parent::addChild);
+
+				return parent;
+			}
+
+			return node.transformHead(mapper);
+		});
+	}
 
 	/**
-	 * Get the specified child of this tree
+	 * Get the specified child of this tree.
 	 *
 	 * @param childNo
-	 *                The number of the child to get
-	 * @return The specified child of this tree
+	 *                The number of the child to get.
+	 * 
+	 * @return The specified child of this tree.
 	 */
 	default ITree<ContainedType> getChild(int childNo) {
 		return transformChild(childNo, (child) -> child);
 	}
 
 	/**
-	 * Get a count of the number of direct children this node has
+	 * Get a count of the number of direct children this node has.
 	 *
-	 * @return The number of direct children this node has
+	 * @return The number of direct children this node has.
 	 */
-	public int getChildrenCount();
+	int getChildrenCount();
 
 	/**
-	 * Get the data stored in this node
+	 * Get the data stored in this node.
 	 *
-	 * @return The data stored in this node
+	 * @return The data stored in this node.
 	 */
 	default ContainedType getHead() {
 		return transformHead((head) -> head);
 	}
 
 	/**
-	 * Rebuild the tree with the same structure, but different nodes
+	 * Rebuild the tree with the same structure, but different nodes.
 	 *
 	 * @param <MappedType>
-	 *                The type of the new tree
+	 *                The type of the new tree.
+	 * 
 	 * @param leafTransformer
-	 *                The function to use to transform leaf tokens
+	 *                The function to use to transform leaf tokens.
+	 * 
 	 * @param operatorTransformer
-	 *                The function to use to transform internal tokens
-	 * @return The tree, with the nodes changed
+	 *                The function to use to transform internal tokens.
+	 * 
+	 * @return The tree, with the nodes changed.
 	 */
-	public <MappedType> ITree<MappedType> rebuildTree(Function<ContainedType, MappedType> leafTransformer,
+	<MappedType> ITree<MappedType> rebuildTree(Function<ContainedType, MappedType> leafTransformer,
 			Function<ContainedType, MappedType> operatorTransformer);
 
 	/**
-	 * Transform some of the nodes in this tree
+	 * Transform some of the nodes in this tree.
 	 *
 	 * @param nodePicker
-	 *                The predicate to use to pick nodes to transform
+	 *                The predicate to use to pick nodes to transform.
+	 * 
 	 * @param transformer
-	 *                The function to use to transform picked nodes
+	 *                The function to use to transform picked nodes.
 	 */
-	public void selectiveTransform(Predicate<ContainedType> nodePicker, UnaryOperator<ContainedType> transformer);
+	void selectiveTransform(Predicate<ContainedType> nodePicker, UnaryOperator<ContainedType> transformer);
 
 	/**
-	 * Do a top-down transform of the tree
+	 * Do a top-down transform of the tree.
 	 *
 	 * @param transformPicker
-	 *                The function to use to pick how to progress
+	 *                The function to use to pick how to progress.
+	 * 
 	 * @param transformer
-	 *                The function used to transform picked subtrees
-	 * @return The tree with the transform applied to picked subtrees
+	 *                The function used to transform picked subtrees.
+	 * 
+	 * @return The tree with the transform applied to picked subtrees.
 	 */
-	public ITree<ContainedType> topDownTransform(Function<ContainedType, TopDownTransformResult> transformPicker,
+	ITree<ContainedType> topDownTransform(Function<ContainedType, TopDownTransformResult> transformPicker,
 			UnaryOperator<ITree<ContainedType>> transformer);
 
 	/**
-	 * Transform one of this nodes children
+	 * Transform one of this nodes children.
 	 *
 	 * @param <TransformedType>
-	 *                The type of the transformed value
+	 *                The type of the transformed value.
+	 * 
 	 * @param childNo
-	 *                The number of the child to transform
+	 *                The number of the child to transform.
+	 * 
 	 * @param transformer
-	 *                The function to use to transform the value
-	 * @return The transformed value
+	 *                The function to use to transform the value.
+	 * 
+	 * @return The transformed value.
 	 *
 	 * @throws IllegalArgumentException
 	 *                 if the childNo is out of bounds (0 <= childNo <=
-	 *                 childCount())
+	 *                 childCount()).
 	 */
-	public <TransformedType> TransformedType transformChild(int childNo,
+	<TransformedType> TransformedType transformChild(int childNo,
 			Function<ITree<ContainedType>, TransformedType> transformer);
 
 	/**
-	 * Transform the value that is the head of this node
+	 * Transform the value that is the head of this node.
 	 *
 	 * @param <TransformedType>
-	 *                The type of the transformed value
+	 *                The type of the transformed value.
+	 * 
 	 * @param transformer
-	 *                The function to use to transform the value
-	 * @return The transformed value
+	 *                The function to use to transform the value.
+	 * 
+	 * @return The transformed value.
 	 */
-	public <TransformedType> TransformedType transformHead(Function<ContainedType, TransformedType> transformer);
+	<TransformedType> TransformedType transformHead(Function<ContainedType, TransformedType> transformer);
 
 	/**
-	 * Transform the tree into a tree with a different type of token
+	 * Transform the tree into a tree with a different type of token.
 	 *
 	 * @param <MappedType>
-	 *                The type of the new tree
+	 *                The type of the new tree.
+	 * 
 	 * @param transformer
-	 *                The function to use to transform tokens
-	 * @return A tree with the token types transformed
+	 *                The function to use to transform tokens.
+	 * 
+	 * @return A tree with the token types transformed.
 	 */
-	public <MappedType> ITree<MappedType> transformTree(Function<ContainedType, MappedType> transformer);
+	default <MappedType> ITree<MappedType> transformTree(Function<ContainedType, MappedType> transformer) {
+		return rebuildTree(transformer, transformer);
+	}
 
 	/**
-	 * Perform an action on each part of the tree
+	 * Perform an action on each part of the tree.
 	 *
 	 * @param linearizationMethod
-	 *                The way to traverse the tree
+	 *                The way to traverse the tree.
+	 * 
 	 * @param action
-	 *                The action to perform on each tree node
+	 *                The action to perform on each tree node.
 	 */
-	public void traverse(TreeLinearizationMethod linearizationMethod, Consumer<ContainedType> action);
+	void traverse(TreeLinearizationMethod linearizationMethod, Consumer<ContainedType> action);
 
 	/**
 	 * Find the farthest to right child that satisfies the given predicate.