traitgraph 8.1.2

Abstracting over different graph representations
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

use crate::interface::GraphBase;

/// A type that represents a subgraph of another graph.
pub trait SubgraphBase: GraphBase {
    /// The root graph of this subgraph, which is either its parent or the root of a DAG of subgraphs.
    type RootGraph: GraphBase<
        NodeData = Self::NodeData,
        EdgeData = Self::EdgeData,
        NodeIndex = Self::NodeIndex,
        EdgeIndex = Self::EdgeIndex,
        OptionalNodeIndex = Self::OptionalNodeIndex,
        OptionalEdgeIndex = Self::OptionalEdgeIndex,
    >;

    /// Returns a reference to the root graph of this subgraph.
    fn root(&self) -> &Self::RootGraph;
}

/// A type that represents a mutable subgraph, to which nodes and edges existing in the parent graph can be added,
/// and nodes and edges can be removed.
pub trait MutableSubgraph: SubgraphBase {
    /// Removes all nodes and edges from the subgraph.
    fn clear(&mut self);

    /// Adds all nodes and edges from the parent graph to this subgraph.
    fn fill(&mut self);

    /// Enables the given node index that exists in the root graph in this subgraph.
    /// This method should only be called for nodes that are enabled in the parent of this subgraph.
    fn enable_node(
        &mut self,
        node_index: <<Self as SubgraphBase>::RootGraph as GraphBase>::NodeIndex,
    );

    /// Enables the given edge index that exists in the root graph in this subgraph.
    /// This method should only be called for edges that are enabled in the parent of this subgraph.
    fn enable_edge(
        &mut self,
        edge_index: <<Self as SubgraphBase>::RootGraph as GraphBase>::EdgeIndex,
    );

    /// Disables the given node index that exists in the root graph in this subgraph.
    /// This method should only be called for nodes that are enabled in the parent of this subgraph.
    fn disable_node(
        &mut self,
        node_index: <<Self as SubgraphBase>::RootGraph as GraphBase>::NodeIndex,
    );

    /// Disables the given edge index that exists in the root graph in this subgraph.
    /// This method should only be called for edges that are enabled in the parent of this subgraph.
    fn disable_edge(
        &mut self,
        edge_index: <<Self as SubgraphBase>::RootGraph as GraphBase>::EdgeIndex,
    );
}

/// A subgraph type for which an empty instance can be constructed using an instance of the root graph type.
pub trait EmptyConstructibleSubgraph<'a>: SubgraphBase {
    /// Construct an empty subgraph instance for the given root graph.
    fn new_empty(graph: &'a <Self as SubgraphBase>::RootGraph) -> Self;
}