sheaf 0.1.7

Hierarchical structure, community detection, reconciliation, and conformal prediction
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

//! Generic tree node.

use core::fmt;

/// A node in a hierarchical tree.
///
/// Nodes can be either leaf nodes (containing original items) or internal
/// nodes (containing summaries of their children).
#[derive(Debug, Clone)]
pub struct Node<T, S = T> {
    /// Unique identifier for this node.
    pub id: usize,
    /// The content at this node (item for leaves, summary for internal).
    pub content: NodeContent<T, S>,
    /// Depth in tree (0 = leaves).
    pub level: usize,
    /// Child node IDs (empty for leaves).
    pub children: Vec<usize>,
    /// Optional metadata.
    pub metadata: Option<NodeMetadata>,
}

/// Content of a tree node.
#[derive(Debug, Clone)]
pub enum NodeContent<T, S = T> {
    /// Leaf node containing an original item.
    Leaf(T),
    /// Internal node containing a summary of children.
    Summary(S),
}

/// Metadata about a node's construction.
#[derive(Debug, Clone, Default)]
pub struct NodeMetadata {
    /// Number of leaf descendants.
    pub leaf_count: usize,
    /// Clustering method used to group children.
    pub cluster_method: Option<String>,
    /// Summarization method used.
    pub summary_method: Option<String>,
}

impl<T, S> Node<T, S> {
    /// Create a new leaf node.
    pub fn leaf(id: usize, item: T) -> Self {
        Self {
            id,
            content: NodeContent::Leaf(item),
            level: 0,
            children: Vec::new(),
            metadata: None,
        }
    }

    /// Create a new internal (summary) node.
    pub fn internal(id: usize, summary: S, level: usize, children: Vec<usize>) -> Self {
        Self {
            id,
            content: NodeContent::Summary(summary),
            level,
            children,
            metadata: None,
        }
    }

    /// Check if this is a leaf node.
    pub fn is_leaf(&self) -> bool {
        matches!(self.content, NodeContent::Leaf(_))
    }

    /// Get the item if this is a leaf node.
    pub fn as_leaf(&self) -> Option<&T> {
        match &self.content {
            NodeContent::Leaf(item) => Some(item),
            _ => None,
        }
    }

    /// Get the summary if this is an internal node.
    pub fn as_summary(&self) -> Option<&S> {
        match &self.content {
            NodeContent::Summary(summary) => Some(summary),
            _ => None,
        }
    }

    /// Add metadata to this node.
    pub fn with_metadata(mut self, metadata: NodeMetadata) -> Self {
        self.metadata = Some(metadata);
        self
    }
}

impl<T: fmt::Display, S: fmt::Display> fmt::Display for Node<T, S> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match &self.content {
            NodeContent::Leaf(item) => write!(f, "Leaf[{}]: {}", self.id, item),
            NodeContent::Summary(summary) => {
                write!(f, "Node[{}] L{}: {}", self.id, self.level, summary)
            }
        }
    }
}