Struct SimilarityMatrix 

pub struct SimilarityMatrix { /* private fields */ }

Similarity matrix between nodes of two graphs.

Stores an [n1 x n2] matrix where entry (i, j) represents the similarity between node i in graph 1 and node j in graph 2.

Implementations

impl SimilarityMatrix

pub fn new(n1: usize, n2: usize) -> Result<Self>

Create a new similarity matrix initialized to uniform values 1 / (n1 * n2).

Errors

Returns an error if either dimension is zero.

pub fn from_prior(prior: Array2<f64>) -> Result<Self>

Create a similarity matrix from a prior similarity array.

The prior is normalized so that all entries sum to 1.

Errors

Returns an error if the prior has zero dimensions or all-zero entries.

pub fn get(&self, i: usize, j: usize) -> f64

Get the similarity between node i in G1 and node j in G2.

Returns 0.0 if indices are out of bounds.

pub fn set(&mut self, i: usize, j: usize, value: f64)

Set the similarity between node i in G1 and node j in G2.

Does nothing if indices are out of bounds.

pub fn normalize(&mut self)

Normalize the matrix so that all entries sum to 1.

If the sum is zero, sets all entries to uniform 1 / (n1 * n2).

pub fn as_array(&self) -> &Array2<f64>

Return a reference to the underlying array.

pub fn n1(&self) -> usize

Return the number of rows (nodes in G1).

pub fn n2(&self) -> usize

Return the number of columns (nodes in G2).

Trait Implementations

impl Clone for SimilarityMatrix

fn clone(&self) -> SimilarityMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimilarityMatrix

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

Formats the value using the given formatter.