Skip to main content

Graph

Struct Graph 

Source
pub struct Graph { /* private fields */ }
Expand description

A weighted graph (directed or undirected).

Implementations§

Source§

impl Graph

Source

pub fn new(n_nodes: usize, directed: bool) -> Self

Create an empty graph with n_nodes nodes.

Source

pub fn add_edge(&mut self, from: usize, to: usize, weight: f64) -> Result<()>

Add a weighted edge.

§Errors

Returns an error if either node index is out of range.

Source

pub fn from_correlation_matrix(matrix: &[Vec<f64>], threshold: f64) -> Self

Build an undirected graph from a correlation matrix with a threshold.

Adds an edge between nodes i and j if |correlation[i][j]| ≥ threshold. Edge weight is the absolute correlation.

Source

pub fn from_sparse_matrix(matrix: &SparseMatrix) -> Self

Build an undirected graph from a sparse matrix.

For a symmetric matrix (e.g. adjacency/connectivity), each stored entry (i, j, w) with i < j becomes an edge. Entries with i >= j are skipped to avoid double-counting in undirected graphs.

Source

pub fn louvain_with_resolution(&self, resolution: f64) -> Community

Louvain community detection with a resolution parameter.

The resolution parameter γ controls community granularity:

  • γ < 1.0 → fewer, larger communities
  • γ = 1.0 → standard modularity
  • γ > 1.0 → more, smaller communities

Implements both Phase 1 (local moves) and Phase 2 (hierarchical aggregation).

Source

pub fn modularity_with_resolution( &self, assignments: &[usize], resolution: f64, ) -> f64

Compute modularity Q with a resolution parameter.

Q = Σ_c [L_c / m - γ * (d_c / 2m)²]

Source

pub fn n_nodes(&self) -> usize

Number of nodes.

Source

pub fn n_edges(&self) -> usize

Number of edges.

Source

pub fn neighbors(&self, node: usize) -> &[(usize, f64)]

Neighbors of a node with edge weights.

Source

pub fn degree_centrality(&self) -> Vec<f64>

Degree centrality: degree(v) / (n - 1).

Source

pub fn betweenness_centrality(&self) -> Vec<f64>

Betweenness centrality using Brandes’ algorithm.

Source

pub fn closeness_centrality(&self) -> Vec<f64>

Closeness centrality: (n-1) / Σ d(v, u).

Source

pub fn centrality(&self) -> CentralityScores

Compute all three centrality metrics.

Source

pub fn louvain(&self) -> Community

Louvain community detection.

Iteratively moves nodes between communities to maximize modularity.

Source

pub fn modularity(&self, assignments: &[usize]) -> f64

Compute modularity Q for a given community assignment.

Uses the community-level formula: Q = Σ_c [L_c / m - (d_c / 2m)²] where L_c = sum of edge weights within community c, m = total edge weight, and d_c = sum of node degrees in community c.

Trait Implementations§

Source§

impl Clone for Graph

Source§

fn clone(&self) -> Graph

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Graph

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Graph

§

impl RefUnwindSafe for Graph

§

impl Send for Graph

§

impl Sync for Graph

§

impl Unpin for Graph

§

impl UnsafeUnpin for Graph

§

impl UnwindSafe for Graph

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.