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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

use super::bfs_enumeration::BreadthFirstEnumeration;
use super::queue::Item;
use crate::TreeVariant;
use crate::tree_variant::RefsChildren;
use alloc::collections::VecDeque;
use core::marker::PhantomData;
use orx_self_or::SoM;
use orx_selfref_col::NodePtr;

pub struct BfsIterPtr<V, E, S = VecDeque<Item<V, E>>>
where
    E: BreadthFirstEnumeration,
    V: TreeVariant,
    S: SoM<VecDeque<Item<V, E>>>,
{
    stack: S,
    phantom: PhantomData<(V, E)>,
}

impl<V, E, S> From<(S, NodePtr<V>)> for BfsIterPtr<V, E, S>
where
    E: BreadthFirstEnumeration,
    V: TreeVariant,
    S: SoM<VecDeque<Item<V, E>>>,
{
    fn from((mut stack, root): (S, NodePtr<V>)) -> Self {
        stack.get_mut().clear();
        stack.get_mut().push_back(E::from_root(root));
        Self {
            stack,
            phantom: PhantomData,
        }
    }
}

impl<V, E> Default for BfsIterPtr<V, E, VecDeque<Item<V, E>>>
where
    E: BreadthFirstEnumeration,
    V: TreeVariant,
{
    fn default() -> Self {
        Self {
            stack: VecDeque::default(),
            phantom: PhantomData,
        }
    }
}

impl<V, E> Clone for BfsIterPtr<V, E, VecDeque<Item<V, E>>>
where
    E: BreadthFirstEnumeration,
    V: TreeVariant,
    Item<V, E>: Clone,
{
    fn clone(&self) -> Self {
        Self {
            stack: self.stack.clone(),
            phantom: PhantomData,
        }
    }
}

impl<V, E, S> Iterator for BfsIterPtr<V, E, S>
where
    E: BreadthFirstEnumeration,
    V: TreeVariant,
    S: SoM<VecDeque<Item<V, E>>>,
{
    type Item = Item<V, E>;

    fn next(&mut self) -> Option<Self::Item> {
        self.stack.get_mut().pop_front().inspect(|element| {
            let node_ptr = E::node_value(element);
            let parent = unsafe { &*node_ptr.ptr() };
            let children_ptr = parent.next().children_ptr();
            let children = E::children(element, children_ptr);
            self.stack.get_mut().extend(children);
        })
    }
}