orx_tree/traversal/breadth_first/
traverser.rs

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
use super::queue::Queue;
use crate::traversal::{
    over::{Over, OverData},
    traverser::Traverser,
};

/// A breadth first search traverser, also known as level-order
/// ([wikipedia](https://en.wikipedia.org/wiki/Tree_traversal#Breadth-first_search)).
///
/// A traverser can be created once and used to traverse over trees multiple times without
/// requiring additional memory allocation.
///
/// # Construction
///
/// A depth first traverser can be created,
/// * either by using Default trait and providing its two generic type parameters
///   * `Dfs::<_, OverData>::default()` or `Dfs::<_, OverDepthSiblingIdxData>::default()`, or
///   * `Dfs::<Dyn<u64>, OverData>::default()` or `Dfs::<Dary<2, String>, OverDepthSiblingIdxData>::default()`
///     if we want the complete type signature.
/// * or by using the [`Traversal`] type.
///   * `Traversal.dfs()` or `Traversal.dfs().with_depth().with_sibling_idx()`.
///
/// [`Traversal`]: crate::Traversal
pub struct Bfs<O = OverData>
where
    O: Over,
{
    pub(crate) queue: Queue<O::Enumeration>,
}

impl Default for Bfs {
    fn default() -> Self {
        Self::new()
    }
}

impl<O> Traverser<O> for Bfs<O>
where
    O: Over,
{
    type IntoOver<O2>
        = Bfs<O2>
    where
        O2: Over;

    fn new() -> Self {
        Self {
            queue: Default::default(),
        }
    }

    fn transform_into<O2: Over>(self) -> Self::IntoOver<O2> {
        Bfs::<O2>::new()
    }
}