orx-tree 2.2.0

A beautiful tree 🌳 with convenient, efficient, parallelizable growth, mutation and traversal features.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use crate::{
    MemoryPolicy, Node, TreeVariant, aliases::Col, node_ref::NodeRefCore,
    pinned_storage::PinnedStorage,
};
use orx_selfref_col::NodePtr;

/// An iterator which can traverse the tree arbitrarily in any direction where the walk direction
/// is determined by a custom `next_node` closure with signature `Fn(Node) -> Option(Node)`.
pub struct CustomWalkIterPtr<'a, V, M, P, F>
where
    V: TreeVariant + 'a,
    M: MemoryPolicy,
    P: PinnedStorage,
    F: Fn(Node<'a, V, M, P>) -> Option<Node<'a, V, M, P>>,
{
    col: &'a Col<V, M, P>,
    current: Option<NodePtr<V>>,
    next_node: F,
}

impl<'a, V, M, P, F> CustomWalkIterPtr<'a, V, M, P, F>
where
    V: TreeVariant + 'a,
    M: MemoryPolicy,
    P: PinnedStorage,
    F: Fn(Node<'a, V, M, P>) -> Option<Node<'a, V, M, P>>,
{
    pub(crate) fn new(col: &'a Col<V, M, P>, current: Option<NodePtr<V>>, next_node: F) -> Self {
        Self {
            col,
            current,
            next_node,
        }
    }
}

impl<'a, V, M, P, F> Iterator for CustomWalkIterPtr<'a, V, M, P, F>
where
    V: TreeVariant + 'a,
    M: MemoryPolicy,
    P: PinnedStorage,
    F: Fn(Node<'a, V, M, P>) -> Option<Node<'a, V, M, P>>,
{
    type Item = NodePtr<V>;

    fn next(&mut self) -> Option<Self::Item> {
        self.current.inspect(|current| {
            let node = Node::new(self.col, *current);
            self.current = (self.next_node)(node).map(|x| x.node_ptr());
        })
    }
}