Struct Graph 

pub struct Graph<V>
where
    V: Eq + Hash + Clone + Debug,
{ /* private fields */ }

Represents a generic symbolic graph. V is the type for vertex labels (e.g., String, Expr). cbindgen:ignore

Implementations

impl<V> Graph<V>

where V: Eq + Hash + Clone + Debug,

pub fn new(is_directed: bool) -> Self

Creates a new graph.

Arguments

• is_directed - A boolean indicating whether the graph is directed (true) or undirected (false).

Returns

A new Graph instance.

pub fn nodes(&self) -> &[V]

Returns a reference to the nodes in the graph.

pub const fn node_count(&self) -> usize

Returns the number of nodes in the graph.

pub const fn is_directed(&self) -> bool

Returns true if the graph is directed.

pub fn add_node(&mut self, label: V) -> usize

Adds a node with a given label to the graph.

If a node with the same label already exists, its existing ID is returned.

Arguments

• label - The label of the node (type V).

Returns

The internal usize ID of the node.

pub fn add_edge(&mut self, from_label: &V, to_label: &V, weight: Expr)

Adds an edge between two nodes.

If the graph is undirected, an edge is added in both directions. If the nodes do not exist, they are added to the graph.

Arguments

• from_label - The label of the source node.
• to_label - The label of the destination node.
• weight - The symbolic weight of the edge.

pub fn get_node_id(&self, label: &V) -> Option<usize>

Gets the internal ID of a node given its label.

Arguments

• label - The label of the node.

Returns

An Option<usize> containing the node’s ID if found, None otherwise.

pub fn neighbors(&self, node_id: usize) -> impl Iterator<Item = &(usize, Expr)>

Gets the neighbors of a node.

Arguments

• node_id - The internal ID of the node.

Returns

An iterator over (neighbor_id, edge_weight) tuples.

pub fn out_degree(&self, node_id: usize) -> usize

Gets the out-degree of a node.

The out-degree is the number of edges originating from the node. For undirected graphs, this is equivalent to the degree.

Arguments

• node_id - The internal ID of the node.

Returns

The out-degree as a usize.

pub fn in_degree(&self, node_id: usize) -> usize

Gets the in-degree of a node.

The in-degree is the number of edges terminating at the node. For undirected graphs, this is equivalent to the degree.

Arguments

• node_id - The internal ID of the node.

Returns

The in-degree as a usize.

pub fn get_edges(&self) -> Vec<(usize, usize, Expr)>

Returns a list of all edges in the graph.

For undirected graphs, each edge is listed only once (e.g., (u, v) but not (v, u)).

Returns

A Vec<(usize, usize, Expr)> where each tuple is (from_node_id, to_node_id, edge_weight).

pub fn add_hyperedge(&mut self, labels: &[V], weight: Expr)

Adds a hyperedge that connects a set of vertices.

A hyperedge is an edge that can connect any number of vertices.

Arguments

• labels - A slice of node labels (V) that the hyperedge connects.
• weight - The symbolic weight of the hyperedge.

pub fn to_adjacency_matrix(&self) -> Expr

Returns the adjacency matrix of the graph.

The adjacency matrix A is a square matrix where A[i][j] represents the weight of the edge from node i to node j. If no edge exists, the value is 0.

Returns

An Expr::Matrix representing the adjacency matrix.

pub fn to_incidence_matrix(&self) -> Expr

Returns the incidence matrix of the graph.

The incidence matrix B is a matrix where rows correspond to nodes and columns correspond to edges. B[i][j] is 1 if node i is incident to edge j. For directed graphs, it can be -1 for the source and 1 for the destination.

Returns

An Expr::Matrix representing the incidence matrix.

pub fn to_laplacian_matrix(&self) -> Expr

Returns the Laplacian matrix of the graph (L = D - A).

The Laplacian matrix L is defined as the difference between the degree matrix D (a diagonal matrix with node degrees on the diagonal) and the adjacency matrix A. It is a fundamental matrix in spectral graph theory.

Returns

An Expr::Matrix representing the Laplacian matrix.

Trait Implementations

impl<V> Clone for Graph<V>

where V: Eq + Hash + Clone + Debug + Clone,

fn clone(&self) -> Graph<V>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<V> Debug for Graph<V>

where V: Eq + Hash + Clone + Debug + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, V> Deserialize<'de> for Graph<V>

where V: Eq + Hash + Clone + Debug + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V> Serialize for Graph<V>

where V: Eq + Hash + Clone + Debug + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.