Struct Hypergraph

pub struct Hypergraph<N: Node, E: EdgeWeight, Ix: IndexType = u32> { /* private fields */ }

A hypergraph structure where hyperedges can connect any number of vertices

A hypergraph is a generalization of a graph where edges (called hyperedges) can connect any number of vertices, not just two. This is useful for modeling complex relationships where multiple entities interact simultaneously.

Implementations

impl<N: Node, E: EdgeWeight, Ix: IndexType> Hypergraph<N, E, Ix>

pub fn new() -> Self

Create a new empty hypergraph

pub fn add_node(&mut self, node: N)

Add a node to the hypergraph

pub fn add_hyperedge(&mut self, nodes: HashSet<N>, weight: E) -> Result<usize>

Add a hyperedge connecting a set of nodes with a given weight

Arguments

• nodes - Set of nodes to connect
• weight - Weight of the hyperedge

Returns

• The ID of the created hyperedge

pub fn add_hyperedge_from_vec( &mut self, nodes: Vec<N>, weight: E, ) -> Result<usize>

Add a hyperedge from a vector of nodes (convenience method)

pub fn remove_hyperedge( &mut self, hyperedge_id: usize, ) -> Result<Hyperedge<N, E>>

where N: Clone, E: Clone,

Remove a hyperedge by its ID

pub fn nodes(&self) -> Iter<'_, N>

Get all nodes in the hypergraph

pub fn hyperedges(&self) -> Vec<Hyperedge<N, E>>

where N: Clone, E: Clone,

Get all hyperedges in the hypergraph

pub fn get_hyperedge(&self, hyperedge_id: usize) -> Option<Hyperedge<N, E>>

where N: Clone, E: Clone,

Get a specific hyperedge by its ID

pub fn hyperedges_containing_node(&self, node: &N) -> Vec<Hyperedge<N, E>>

where N: Clone, E: Clone,

Get all hyperedges that contain a specific node

pub fn neighbors(&self, node: &N) -> HashSet<N>

where N: Clone,

Get all nodes that are connected to a given node through some hyperedge

Returns all nodes that share at least one hyperedge with the given node

pub fn node_count(&self) -> usize

Number of nodes in the hypergraph

pub fn hyperedge_count(&self) -> usize

Number of hyperedges in the hypergraph

pub fn has_node(&self, node: &N) -> bool

Check if the hypergraph contains a specific node

pub fn has_hyperedge(&self, hyperedge_id: usize) -> bool

Check if the hypergraph contains a specific hyperedge

pub fn degree(&self, node: &N) -> usize

Get the degree of a node (number of hyperedges it participates in)

pub fn hyperedge_size(&self, hyperedge_id: usize) -> Option<usize>

Get the size of a hyperedge (number of nodes it connects)

pub fn are_connected(&self, node1: &N, node2: &N) -> bool

Check if two nodes are connected (share at least one hyperedge)

pub fn connecting_hyperedges(&self, node1: &N, node2: &N) -> Vec<usize>

Get the hyperedges that connect two specific nodes

pub fn to_graph(&self) -> Graph<N, E, Ix>

where N: Clone, E: Clone + Zero + Add<Output = E>,

Convert to a regular graph by creating edges between all pairs of nodes that are connected by the same hyperedge

This creates the 2-section (or clique expansion) of the hypergraph

pub fn incidence_matrix(&self) -> Array2<u8>

where N: Clone + Ord,

Get the incidence matrix of the hypergraph

Returns a matrix where rows represent nodes and columns represent hyperedges. Entry (i,j) is 1 if node i is in hyperedge j, 0 otherwise.

pub fn is_uniform(&self) -> bool

Check if the hypergraph is uniform (all hyperedges have the same size)

pub fn uniformity(&self) -> Option<usize>

Get the uniformity of the hypergraph (the common size if uniform, None otherwise)

pub fn hyperedge_size_stats(&self) -> (usize, usize, f64)

Get statistics about hyperedge sizes

pub fn maximal_cliques(&self) -> Vec<HashSet<N>>

where N: Clone,

Find all maximal cliques in the hypergraph

A maximal clique is a set of nodes that are all connected to each other and cannot be extended by adding another node while maintaining this property. In hypergraphs, this corresponds to finding maximal sets of nodes that all participate in some common hyperedge.

pub fn from_graph(graph: &Graph<N, E, Ix>) -> Self

where N: Clone, E: Clone,

Create a hypergraph from a regular graph where each edge becomes a 2-uniform hyperedge

Trait Implementations

impl<N: Node, E: EdgeWeight, Ix: IndexType> Default for Hypergraph<N, E, Ix>

fn default() -> Self

Returns the “default value” for a type.