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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use super::BreadthFirstEnumeration;
use super::iter_ptr::BfsIterPtr;
use super::queue::Item;
use crate::TreeVariant;
use crate::aliases::Col;
use crate::memory::MemoryPolicy;
use crate::pinned_storage::PinnedStorage;
use alloc::collections::VecDeque;
use orx_self_or::SoM;
use orx_selfref_col::{NodePtr, Refs};

pub struct BfsIterInto<'a, V, M, P, E, S>
where
    V: TreeVariant,
    M: MemoryPolicy,
    P: PinnedStorage,
    E: BreadthFirstEnumeration,
    S: SoM<VecDeque<Item<V, E>>>,
{
    col: &'a mut Col<V, M, P>,
    root_ptr: NodePtr<V>,
    iter: BfsIterPtr<V, E, S>,
}

impl<'a, V, M, P, E, S> BfsIterInto<'a, V, M, P, E, S>
where
    V: TreeVariant,
    M: MemoryPolicy,
    P: PinnedStorage,
    E: BreadthFirstEnumeration,
    S: SoM<VecDeque<Item<V, E>>>,
{
    /// # Safety
    ///
    /// We are creating a mutable iterator over nodes of the collection `col`.
    /// This is safe only when the second argument `iter` makes sure that there exists only one mutable
    /// reference to the collection.
    ///
    /// This is the case how this method is used, as follows:
    /// * Mutable iterators are created through the `Dfs` traverser's `TraverserMut::iter_mut` method.
    /// * This method requires a mutable reference to a mutable node `NodeMut` which is guaranteed to
    ///   be the only reference to the collection.
    /// * Finally, this iterator's lifetime is equal to the borrow duration of the mutable node.
    #[allow(clippy::type_complexity)]
    pub(crate) unsafe fn from(
        (col, iter, root_ptr): (&'a mut Col<V, M, P>, BfsIterPtr<V, E, S>, NodePtr<V>),
    ) -> Self {
        let node = unsafe { &mut *root_ptr.ptr_mut() };

        match node.prev().get() {
            Some(parent) => {
                let parent = unsafe { &mut *parent.ptr_mut() };
                let sibling_idx = parent.next_mut().remove(unsafe { root_ptr.ptr() as usize });
                debug_assert!(sibling_idx.is_some());

                node.prev_mut().clear();
            }
            None => {
                // node_ptr points to the root node
                col.ends_mut().clear();
            }
        }

        Self {
            col,
            root_ptr,
            iter,
        }
    }

    fn take_element(&mut self, element: E::Item<NodePtr<V>>) -> E::Item<V::Item> {
        E::map_node_data(element, |ptr| {
            let col = unsafe { &mut *(self.col as *mut Col<V, M, P>) };
            col.close(ptr)
        })
    }
}

impl<V, M, P, E, S> Iterator for BfsIterInto<'_, V, M, P, E, S>
where
    V: TreeVariant,
    M: MemoryPolicy,
    P: PinnedStorage,
    E: BreadthFirstEnumeration,
    S: SoM<VecDeque<Item<V, E>>>,
{
    type Item = E::Item<V::Item>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next().map(|element| self.take_element(element))
    }
}

impl<V, M, P, E, S> Drop for BfsIterInto<'_, V, M, P, E, S>
where
    V: TreeVariant,
    M: MemoryPolicy,
    P: PinnedStorage,
    E: BreadthFirstEnumeration,
    S: SoM<VecDeque<Item<V, E>>>,
{
    fn drop(&mut self) {
        while let Some(element) = self.iter.next() {
            self.take_element(element);
        }
        self.col.reclaim_from_closed_node(self.root_ptr);
    }
}