spqr-tree 5.1.0

A representation of the SPQR tree in Rust with support for I/O
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

use std::borrow::Cow;

use crate::decomposition::indices::{GraphIndex, GraphIndexInteger};

pub mod implementations;

/// An undirected graph without multiedges or self-loops.
pub trait StaticGraph {
    /// The integer type used for indices in this graph.
    type IndexType: GraphIndexInteger;

    type NodeIndex: GraphIndex;

    type EdgeIndex: GraphIndex;

    /// Returns an iterator over all node indices in the graph.
    fn node_indices(&self) -> impl Iterator<Item = Self::NodeIndex>;

    /// Returns an iterator over all edge indices in the graph.
    fn edge_indices(&self) -> impl Iterator<Item = Self::EdgeIndex>;

    /// Returns the number of nodes in the graph.
    fn node_count(&self) -> usize;

    /// Returns the number of edges in the graph.
    fn edge_count(&self) -> usize;

    /// Returns the name of the given node.
    fn node_name(&self, node_index: Self::NodeIndex) -> Cow<'_, str>;

    /// Returns an iterator over the incident edges of the given node.
    ///
    /// Each edge is returned exactly once.
    fn incident_edges(&self, node: Self::NodeIndex) -> impl Iterator<Item = Self::EdgeIndex>;

    /// Returns the endpoints of the given edge as a tuple of node indices.
    fn edge_endpoints(&self, edge: Self::EdgeIndex) -> (Self::NodeIndex, Self::NodeIndex);

    /// Returns the edges between the two given nodes.
    fn edges_between(
        &self,
        u: Self::NodeIndex,
        v: Self::NodeIndex,
    ) -> impl Iterator<Item = Self::EdgeIndex>;
}

pub trait NamedNodeData {
    fn name(&'_ self) -> Cow<'_, str>;
}

pub trait NamedEdgeData {
    fn name(&'_ self) -> Cow<'_, str>;
}