Crate orx_tree

Expand description

§orx-tree

A beautiful tree 🌳 with convenient, efficient, parallelizable growth, mutation and traversal features.

§Tree Variants

Tree is generic over variants that define the way the children are stored:

DynTree<T>, or equivalently Tree<Dyn<T>>, is a tree where each node may contain references to any number of children stored as a vector.
DaryTree<D, T>, or equivalently Tree<Dary<D, T>>, is a tree where each node may contain at most D child references stored inlined as an array.
BinaryTree<T> is simply a shorthand for DaryTree<2, T>.

§Recursive Nature of Trees

Note that Tree has only few methods which mainly allow access to the root or to any node using node indices. Since every node is the root of a subtree, the core tree functionalities are provided as methods of NodeRef and NodeMut, which are immutable and mutable nodes, respectively.

§Iterations

§Walks over the Tree

We can visit all nodes of the tree in various ways. The way we walk, or the order of visited nodes, is determined by a generic traversal parameter.

To demonstrate, consider the following methods of a tree node:

walk::<Bfs>() creates an iterator that visits all the nodes belonging to the subtree rooted at the node in the breadth-first order.
walk_mut::<Dfs>() creates a mutable iterator, this time in depth-first order.
into_walk::<PostOrder>(), on the other hand, takes the subtree rooted at the node out of the tree and yields the elements in post-order.

Walk iterators might yield node values or nodes with access to children, parent, siblings, etc. Further, node depth and/or its position among its siblings might be added. These more specialized traversals can be created conveniently using the Traversal builder type.

You may see the walks example that demonstrates different ways to walk the tree with traversal variants (cargo run --example walks).

use orx_tree::*;

//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱     ╱ ╲
// 4     5   6
let mut tree = DynTree::new(1);
let [id2, id3] = tree.root_mut().push_children([2, 3]);
let id4 = tree.node_mut(&id2).push_child(4);
tree.node_mut(&id3).push_children([5, 6]);

let root = tree.root();
assert_eq!(root.walk::<Dfs>().copied().collect::<Vec<_>>(), [1, 2, 4, 3, 5, 6]);
assert_eq!(root.walk::<Bfs>().copied().collect::<Vec<_>>(), [1, 2, 3, 4, 5, 6]);
assert_eq!(root.walk::<PostOrder>().copied().collect::<Vec<_>>(), [4, 2, 5, 6, 3, 1]);

// create a re-usable BFS traverser, with additional access to depth and sibling-idx
let mut t = Traversal.bfs().with_depth().with_sibling_idx();
assert_eq!(
    root.walk_with(&mut t).collect::<Vec<_>>(),
     [(0, 0, &1), (1, 0, &2), (1, 1, &3), (2, 0, &4), (2, 0, &5), (2, 1, &6)]
);

§Custom Walk

In addition to common traversal strategies, we can create a custom iterator by simply calling custom_walk(next_node) where the argument next_node is a function with signature Fn(Node) -> Option<Node> defining the traversal strategy.

§Special Iterators

In addition to walks over subtrees, the following iterators are useful in special use cases.

leaves::<Bfs>() returns leaf nodes in breadth-first order.
paths::<Dfs>() returns all the paths or sequences of nodes connecting the node to all of its leaves in the depth-first order.
ancestors() provides an upward iterator from the node to the root of the tree.

You may see the special iterators example.

§Manual Traversals

Alternatively, we can move on nodes of the tree freely:

↓ child(child_idx), children(), children_mut(), into_child_mut(child_idx)
↑ parent(), into_parent_mut(), etc.

You may see manual iteration and mutable_recursive_traversal examples

§Arbitrary Order Iterators

The tree naturally implements IntoIterator, Collection and CollectionMut providing iterators via into_iter, iter and iter_mut methods. These iterators yield elements in an arbitrary but deterministic order.

§Parallelization

Tree aims to enable convenient parallel computation for all iterators, traversals or walks mentioned above using the orx-parallel feature (see features section). Parallel counterparts return a ParIter rather than a sequential Iterator.

tree.par() and tree.into_par() return parallel iterators over all nodes of the tree. Examples can be found in demo_parallelization example. Importantly note that the tree defines its own concurrent iterators, and hence, allows for efficient computation, which is often not possible with generic implementations. In order to check the impact in performance, you may use the lightweight benchmark example bench_parallelization:

Sequential computation over Tree : 18.96s
Parallelized over Tree using orx-parallel : 6.02s
Parallelized over Tree using rayon's par-bridge : 81.10s

Remaining walks and traversals can be parallelized simply by adding _par suffix to names of their sequential counterparts:

§Constant Time Access to Nodes via Node Indices

A NodeIdx for a Tree is similar to usize for a slice in that it allows constant time access to the node it is created for.

On the other hand, it is more specific for the node due to the following:

usize represents a position of the slice. Say we have the slice [a, b, c]. Currently, index 0 points to element a. However, if we swap the first and third elements, index 0 will now be pointing to c because the usize represents a position on the slice.
A node index represents the node it is created for. If the index is created for node a, it will always point to this node no matter how many times we move the node in the tree. Further, we cannot use this node index on another tree and it does not allow access to another node if node a is removed from the tree.

Therefore, node access through node indices is safe. To demonstrate, assume we have the following command:

let idx = tree.root_mut().push_child(42);

Here, idx does not have a lifetime attached to the tree, yet it refers to the node on this tree which currently holds value 42 (thanks to pinned element guarantees). This allows for a safe and efficient access to the nodes:

tree.node(&idx) provides a constant time access to this particular node.
another_tree.node(&idx) is an out-of-bounds error.
tree.node(&idx) after removing the node from the tree, say by tree.node_mut(&idx).prune() call, is a removed-node error.

§Cache Locality

Nodes of the tree are stored in an underlying PinnedVec with pinned element guarantees. This allows for keeping the nodes close to each other improving cache locality while still providing with constant time mutation methods.

§Convenient Mutations

The tree aims to make every move on the tree possible, convenient and efficient.

§Growth & Move Subtrees Around

The following methods demonstrate downward growth by adding descendants to a node:

push_child(value) => adds a single child
push_children(values) => adds a constant number of children
extend_children(values) => adds a variable number of children provided by an iterator
push_child_tree(subtree) => appends the subtree as descendants of the node such that the root of the subtree is the child of the node
push_child_tree_within(subtree) => similar to the above except that the subtree belongs to the same tree, we might be moving or cloning the subtree

These methods have the sibling variants such as push_sibling rather than push_child which additionally allows to define the side of the new sibling (to the left or right).

Further, push_parent(value) allows to push a node in between a node and its parent.

These methods aim to enable inserting nodes or subtrees at any position of the tree.

Note that all the growth methods return the indices of the created nodes allowing for a fluent growth of the tree.

Additionally, the tree provides methods for special moves such as swap_subtrees to swap components of the same tree.

§Removals

We can take out a node from the tree, while connecting its parent to its children via the take_out method.

Alternatively, we can prune by removing a subtree rooted at a particular node, and receive the value of the root node of the removed subtree.

Alternatively, we can turn a mutable node into an into_walk iterator. Similar to prune, this will remove the subtree. However, we are flexible on what we do with the removed subtree:

We can simply discard it. Then, into_walk behaves similar to prune.
We can iterate over the removed nodes in the order of the generic traversal parameter and use the data however we need.
Or we can attach the removed subtree at a desired position of another tree by passing it to methods such as push_child_tree(subtree).

§Features

orx-parallel: Tree allows efficient parallel processing through concurrent iterators and parallel iterators. See parallelization section for details. This feature is added as default and requires std. Therefore, please use cargo add orx-tree --no-default-features for no-std use cases.
serde: Tree implements Serialize and Deserialize traits; the “serde” feature needs to be added when required. It uses a linearized representation of the tree as a DepthFirstSequence. You may find de-serialization examples in the corresponding test file.

§Examples

The following example demonstrates the basic usage of the Tree by constructing and playing around with mutation and traversal methods.

use orx_tree::*;

// # A. BUILDING A TREE

//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱ ╲
// 4   5 6   7
// |     |  ╱ ╲
// 8     9 10  11

let mut tree = DynTree::new(1i32);

let mut root = tree.root_mut();
let [id2, id3] = root.push_children([2, 3]);
let [id4, _] = tree.node_mut(&id2).push_children([4, 5]);
let id8 = tree.node_mut(&id4).push_child(8);
let [id6, id7] = tree.node_mut(&id3).push_children([6, 7]);
let id9 = tree.node_mut(&id6).push_child(9);
tree.node_mut(&id7).push_children([10, 11]);
println!("{}", &tree);
// 1
// ├──2
// │  ├──4
// │  │  └──8
// │  └──5
// └──3
//     ├──6
//     │  └──9
//     └──7
//         ├──10
//         └──11

// B. NODE

let node4 = tree.node(&id4);

assert!(!node4.is_leaf());
assert!(!node4.is_root());
assert_eq!(node4.depth(), 2);
assert_eq!(node4.height(), 1);
assert_eq!(node4.sibling_idx(), 0);
assert_eq!(node4.parent(), Some(tree.node(&id2)));
assert_eq!(node4.num_children(), 1);
assert_eq!(node4.get_child(0), Some(tree.node(&id8)));

let ancestors: Vec<_> = node4.ancestors().map(|x| *x.data()).collect();
assert_eq!(ancestors, [2, 1]);

let new_tree: BinaryTree<_> = node4.clone_as_tree();
assert_eq!(new_tree.root().data(), &4);
assert_eq!(new_tree.len(), 2);

// # B. TRAVERSALS

let bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]);

let dfs: Vec<_> = tree.node(&id3).walk::<Dfs>().copied().collect();
assert_eq!(dfs, [3, 6, 9, 7, 10, 11]);

let post_order: Vec<_> = tree.node(&id3).walk::<PostOrder>().copied().collect();
assert_eq!(post_order, [9, 6, 10, 11, 7, 3]);

let leaves: Vec<_> = tree.root().leaves::<Dfs>().copied().collect();
assert_eq!(leaves, [8, 5, 9, 10, 11]);

let node3 = tree.node(&id3);
let paths: Vec<Vec<_>> = node3.paths::<Bfs>().map(|p| p.copied().collect()).collect();
assert_eq!(paths, [[9, 6, 3], [10, 7, 3], [11, 7, 3]]);

let sum: i32 = tree.iter().sum(); // Collection: iterate in arbitrary order
assert_eq!(sum, 66);

for x in tree.iter_mut() { // CollectionMut: iterate in arbitrary order
    *x = 2 * (10 + *x) - *x - 20; // do nothing :)
}

// # C. MUTATIONS - REMOVALS

let mut tree = tree.into_lazy_reclaim(); // to keep the indices valid

// > remove a subtree and collect values in the desired traversal order
let node7 = tree.node_mut(&id7);
let removed_in_bfs_order: Vec<_> = node7.into_walk::<Bfs>().collect();
assert_eq!(removed_in_bfs_order, [7, 10, 11]);
let remaining: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(remaining, [1, 2, 3, 4, 5, 6, 8, 9]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱
// 4   5 6
// |     |
// 8     9

// > take out just one node
let node6 = tree.node_mut(&id6);
let taken_out = node6.take_out(); // 6 is removed, 9 moves up
assert_eq!(taken_out, 6);
let remaining: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(remaining, [1, 2, 3, 4, 5, 9, 8]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱
// 4   5 9
// |
// 8

// > prune a subtree
let node2 = tree.node_mut(&id2);
let taken_out = node2.prune(); // 2 is removed, together with descendants
assert_eq!(taken_out, 2);
let remaining: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(remaining, [1, 3, 9]);
//      1
//       ╲
//        ╲
//         3
//        ╱
//       9

// # D. MUTATIONS - ADDING & MOVING SUBTREES

// > append another tree as a sibling of a node
let mut other_tree = DynTree::new(2);
let [id4, _] = other_tree.root_mut().push_children([4, 5]);
other_tree.node_mut(&id4).push_child(8);

let id2 = tree
    .node_mut(&id3)
    .push_sibling_tree(Side::Left, other_tree);
let bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [1, 2, 3, 4, 5, 9, 8]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱
// 4   5 9
// |
// 8

// > move a subtree to another location in the same tree
let node2 = tree.node(&id2);
let [id4, id5] = [node2.child(0).idx(), node2.child(1).idx()];
tree.node_mut(&id3)
    .push_child_tree_within(id4.into_subtree_within());
let bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [1, 2, 3, 5, 9, 4, 8]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//    ╲   ╱ ╲
//     5 9   4
//           |
//           8

// > move the subtree back
tree.node_mut(&id5)
    .push_sibling_tree_within(Side::Left, id4.into_subtree_within());
let bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [1, 2, 3, 4, 5, 9, 8]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱
// 4   5 9
// |
// 8

// > insert a node in between parent & child
tree.node_mut(&id9).push_parent(6);
let bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [1, 2, 3, 4, 5, 6, 8, 9]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱
// 4   5 6
// |     |
// 8     9

// push a subtree cloned/copied from another tree
let mut other_tree = DynTree::new(100);
let id7 = other_tree.root_mut().push_child(7);
other_tree.node_mut(&id7).push_children([10, 11]);

let subtree = other_tree.node(&id7).as_cloned_subtree();
tree.node_mut(&id3).push_child_tree(subtree);

assert_eq!(other_tree.len(), 4); // unchanged

let bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]);
//      1
//     ╱ ╲
//    ╱   ╲
//   2     3
//  ╱ ╲   ╱ ╲
// 4   5 6   7
// |     |  ╱ ╲
// 8     9 10  11

// # E. SPLIT TREE INTO TREES

// let's refresh indices
let idx: Vec<_> = tree.root().indices::<Bfs>().collect();
let id2 = idx[1].clone();
let id7 = idx[6].clone();

// let's move subtree rooted at n2 to its own tree
let tree2: DynTree<_> = tree.node_mut(&id2).into_new_tree();
let bfs: Vec<_> = tree2.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [2, 4, 5, 8]);

// let's move subtree rooted at n7 to its own tree, this time a BinaryTree
let tree7: BinaryTree<_> = tree.node_mut(&id7).into_new_tree();
let bfs: Vec<_> = tree7.root().walk::<Bfs>().copied().collect();
assert_eq!(bfs, [7, 10, 11]);

// these subtrees are moved into new trees; i.e., removed from the original
// alternatively, we could've used 'clone_as_tree' to leave the original tree unchanged
let remaining_bfs: Vec<_> = tree.root().walk::<Bfs>().copied().collect();
assert_eq!(remaining_bfs, [1, 3, 6, 9]);

§More Examples

mutable_recursive_traversal demonstrates different approaches to achieve a recursive mutation of all nodes in the tree.

§Contributing

Contributions are welcome! If you notice an error, have a question or think something could be added or improved, please open an issue or create a PR.

§License

Dual-licensed under Apache 2.0 or MIT.

Re-exports§

pub use memory::Auto;
pub use memory::AutoWithThreshold;
pub use memory::Lazy;
pub use memory::MemoryPolicy;
pub use traversal::Bfs;
pub use traversal::Dfs;
pub use traversal::PostOrder;
pub use traversal::Traversal;
pub use traversal::Traverser;

Modules§

computational_variants: Module containing variants of parallel iterators.
iter: Module defining iterators.
memory: Module defining memory reclaim policies.
pinned_storage: Module defining the choice over the pinned storage of the tree.
runner: Module defining the parallel runner trait and the default parallel runner.
traversal: Module defining tree traversal iterators.

Structs§

Dary: A dynamic tree where each of the nodes might have any number of child nodes.
DepthFirstSequence: A depth first sequence is a representation of a tree in a linear storage of (depth, value) tuples. This is useful in collecting trees from iterators, (de)-serializing trees or converting its variant from one to another.
Dyn: A dynamic tree where each of the nodes might have any number of child nodes.
Node: A node of the tree.
NodeIdx: An index associated only with the node it is created for.
NodeMut: A node of the tree, which in turn is a tree.
NodeMutDown: Allows mutation of only the node itself and its descendants.
NodeMutUpAndDown: Allows mutation of the node itself, its descendants and ancestors; i.e., does limit.
Params: Parameters of a parallel computation.
Tree: Core tree structure.

Enums§

ChunkSize: ChunkSize represents the batch size of elements each thread will pull from the main iterator once it becomes idle again. It is possible to define a minimum or exact chunk size.
DepthFirstSequenceError: A depth first sequence, or DepthFirstSequence is simply a sequence of (usize, T) tuples corresponding to (depth, value) pairs of nodes of a tree which are ordered by the depth-first traversal order.
IterationOrder: Order of parallel iteration, which might be:
NodeIdxError: Error cases of an invalid node index.
NodeSwapError: Error variants that can be observed while swapping two subtrees rooted at two nodes of the tree.
NumThreads: NumThreads represents the degree of parallelization. It is possible to define an upper bound on the number of threads to be used for the parallel computation. When set to 1, the computation will be executed sequentially without any overhead. In this sense, parallel iterators defined in this crate are a union of sequential and parallel execution.
Side: Side of a sibling node relative to a particular node within the children collection.

Traits§

Collection: A collection providing the iter method which returns an iterator over shared references of elements of the collection.
CollectionMut: A mutable collection providing the iter_mut method which returns an iterator over mutable references of elements of the collection.
IntoParIter: Trait to convert a source (collection or generator) into a parallel iterator; i.e., ParIter, using its into_par method.
IterIntoParIter: Any regular iterator implements IterIntoParIter trait allowing them to be used as a parallel iterator; i.e., ParIter, by calling iter_into_par.
NodeMutOrientation: A marker trait determining the mutation flexibility of a mutable node.
NodeRef: Reference to a tree node.
ParCollectInto: Collection types into which outputs of a parallel computations can be collected into.
ParIter: Parallel iterator.
ParallelRunner: A parallel runner which is responsible for taking a computation defined as a composition of iterator methods, spawns threads, shares tasks and returns the result of the parallel execution.
Parallelizable: Parallelizable types are those from which parallel iterators can be created multiple times using the par method, since this method call does not consume the source.
ParallelizableCollection: A type implementing ParallelizableCollection is a collection owning the elements such that
SubTree: A subtree is a subset of a tree, also having a single root and satisfying structural tree properties.
Sum: Number that can be summed over.
ThreadRunner: Thread runner responsible for executing the tasks assigned to the thread by the parallel runner.
TreeVariant: Variant of a tree.

Type Aliases§

Binary: A binary tree where each of the nodes might have at most 2 children.
BinaryNode: Node of a BinaryTree.
BinaryTree: A binary tree where each node might have 0, 1 or 2 children.
DaryNode: Node of a DaryTree.
DaryTree: A d-ary tree where each of the nodes might have at most D children.
DefaultRunner: Default parallel runner.
DynNode: Node of a DynTree.
DynTree: A dynamic tree where each of the nodes might have any number of child nodes.

Crate orx_treeCopy item path