Struct Hypergraph 

pub struct Hypergraph {
    pub n_vertices: usize,
    pub n_hyperedges: usize,
    pub incidence_matrix: Array2<Float>,
    pub hyperedge_weights: Array1<Float>,
    pub vertex_weights: Array1<Float>,
    pub hyperedge_sizes: Array1<usize>,
    pub communities: Option<Array1<usize>>,
}

Hypergraph structure representation

Fields

n_vertices: usize

Number of vertices

n_hyperedges: usize

Number of hyperedges

incidence_matrix: Array2<Float>

Incidence matrix: vertices × hyperedges H[i,e] = 1 if vertex i is in hyperedge e, 0 otherwise

hyperedge_weights: Array1<Float>

Hyperedge weights

vertex_weights: Array1<Float>

Vertex weights (degrees)

hyperedge_sizes: Array1<usize>

Hyperedge size distribution

communities: Option<Array1<usize>>

Optional clustering/community information

Implementations

impl Hypergraph

pub fn new(incidence_matrix: Array2<Float>) -> Result<Self, SklearsError>

Create a new hypergraph from incidence matrix

pub fn from_hyperedges( n_vertices: usize, hyperedges: &[Vec<usize>], ) -> Result<Self, SklearsError>

Create a hypergraph from a list of hyperedges

pub fn with_hyperedge_weights( self, weights: Array1<Float>, ) -> Result<Self, SklearsError>

Set hyperedge weights

pub fn with_communities( self, communities: Array1<usize>, ) -> Result<Self, SklearsError>

Set community assignments

pub fn compute_laplacian( &self, variant: HypergraphLaplacianType, ) -> Array2<Float>

Compute the hypergraph Laplacian matrix

pub fn detect_communities( &mut self, n_communities: usize, ) -> Result<Array1<usize>, SklearsError>

Detect communities using spectral clustering on the hypergraph

pub fn compute_centrality(&self) -> HypergraphCentrality

Compute hypergraph centrality measures

Trait Implementations

impl Clone for Hypergraph

fn clone(&self) -> Hypergraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hypergraph

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

Formats the value using the given formatter.