Struct Hypergraph 

pub struct Hypergraph<N, E> { /* private fields */ }

Generic hypergraph whose nodes carry data of type N and hyperedges carry metadata of type E.

Node and hyperedge indices are plain usize values assigned at insertion time (monotonically increasing).

Example

use scirs2_graph::hypergraph::Hypergraph;

let mut hg: Hypergraph<&str, &str> = Hypergraph::new();
let a = hg.add_node("Alice");
let b = hg.add_node("Bob");
let c = hg.add_node("Carol");
let e = hg.add_hyperedge("team", vec![a, b, c]);
assert_eq!(hg.node_degree(a), 1);
assert_eq!(hg.incident_edges(b), vec![e]);

Implementations

impl<N: Clone, E: Clone> Hypergraph<N, E>

pub fn new() -> Self

Create an empty generic hypergraph.

pub fn add_node(&mut self, data: N) -> usize

Add a node and return its index.

pub fn add_hyperedge(&mut self, data: E, nodes: Vec<usize>) -> usize

Add a hyperedge and return its index.

Duplicate nodes within nodes are silently deduplicated; order is normalised to sorted. Panics if any node index is out of range (use [try_add_hyperedge] for the fallible version).

pub fn try_add_hyperedge(&mut self, data: E, nodes: Vec<usize>) -> Result<usize>

Fallible version of [add_hyperedge] that returns an error when a node index is out of range.

pub fn incident_edges(&self, node: usize) -> Vec<usize>

Return the ids of all hyperedges incident to node.

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

Return the degree (number of incident hyperedges) of a node.

pub fn node_count(&self) -> usize

Number of nodes.

pub fn hyperedge_count(&self) -> usize

Number of hyperedges.

pub fn node_data(&self, id: usize) -> Option<&N>

Access node data by index.

pub fn hyperedge_data(&self, id: usize) -> Option<(&E, &[usize])>

Access hyperedge data and members by index.

pub fn hyperedge_nodes(&self, id: usize) -> Option<&[usize]>

Return the member node indices of hyperedge id.

impl<N: Clone + Debug + Hash + Eq + Ord, E: Clone> Hypergraph<N, E>

pub fn clique_expansion_indexed(&self) -> Graph<usize, f64>

Build the clique expansion (2-section) of this hypergraph as a Graph<usize, f64> where nodes are identified by their index.

Edge weight between u and v accumulates across all hyperedges that contain both.

Trait Implementations

impl<N: Clone, E: Clone> Clone for Hypergraph<N, E>

fn clone(&self) -> Hypergraph<N, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug, E: Debug> Debug for Hypergraph<N, E>

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

Formats the value using the given formatter.

impl<N: Clone, E: Clone> Default for Hypergraph<N, E>

fn default() -> Self

Returns the “default value” for a type.