Libertree

Libertree is a Scala library designed to facilitate the creation, manipulation, and combination of tree data structures. It offers a variety of operations such as mapping, listing, grafting, and pretty-printing. The library is under development and should be used with caution.

Features

Mapping: Apply functions to every element in a tree, producing a transformed tree.
Listing: Convert trees into list representations, maintaining hierarchical order.
Grafting: Enrich trees with data from another tree based on matching criteria, perfect for associating related data across different trees.
Combining: Allows working with two mirrored trees of different types, may be used to do diffs between two versions of a tree.

Usage

Creating Trees

To create trees with Libertree, you can easily nest branches and leaves to represent complex hierarchical data structures.

import com.datanarchi.libs.scala.trees._

val myTree = Tree("Root", List(
  Tree.leaf("Child1"),
  Tree.branch("Child2", List(
    Tree.leaf("Grandchild1"),
    Tree.leaf("Grandchild2")
  ))
))

Mapping Over Trees

Apply a function to each element in the tree, producing a new tree with the results of the function applied to each element.

val capitalizedTree = myTree.map(_.toUpperCase())

Converting to List

Convert your tree into a list representation, preserving the hierarchical order of elements.

val treeAsList = myTree.toList
// Results in List("Root", "Child1", "Child2", "Grandchild1", "Grandchild2")

Grafting Trees

Combine elements from one tree into another based on a matching function. This is particularly useful for enriching data structures with additional information.

val matchingFunction: String => ((String, Int)) => Boolean = name => nameWithPop => name == nameWithPop._1
val patchFunction: String => ((String, Int)) => String = name => nameWithPop => s"$name (${nameWithPop._2} inhabitants)"

val enrichedTree = treeA.graft(treeB)(matchingFunction)(patchFunction)

CombinedTree

The CombinedTree class is a sophisticated feature of the Libertree library, designed to merge and enrich two trees of potentially different types. This abstraction allows for powerful operations where elements from one tree can be combined with elements from another based on specific matching criteria, making it ideal for complex data manipulation and enrichment tasks.

Flexible Merging: Supports merging trees with different structures and data types, allowing for a wide range of applications.
Data Enrichment: Through the zip and zipMap methods, it provides a straightforward way to enrich the data of one tree with another by applying a transformation function based on matching criteria.

Creating a CombinedTree

To create a CombinedTree, you must provide two trees and a join function that defines how to match elements from these trees. The apply method facilitates the creation of a CombinedTree instance:

val combinedTreeOption = CombinedTree(leftTree, rightTree)(joinFunction)

Contributing

Contributions to Libertree are more than welcome! If you have any suggestions for improvement, or if you encounter any issues, please feel free to submit a pull request or open an issue.

License

Libertree is made available under the MIT License.

samihus/libertree