Enum LeidenObjective 

pub enum LeidenObjective {
    Modularity,
    Cpm,
    ErdosRenyi,
}

Objective function optimized by Graph::community_leiden_simple (igraph_leiden_objective_t).

With A the adjacency matrix, m the total edge weight, k the degrees, γ the resolution and δ(c_i, c_j) the co-membership indicator:

Variants

Modularity

Generalized modularity Q = 1/(2m) Σ_ij (A_ij − γ k_i k_j / (2m)) δ(c_i, c_j) (directed: 1/m Σ_ij (A_ij − γ k^out_i k^in_j / m) δ(c_i, c_j)), i.e. a configuration model null model. Weights must be non-negative.

Cpm

Constant Potts model Q = 1/(2m) Σ_ij (A_ij − γ) δ(c_i, c_j), free of the resolution limit. Negative weights are allowed.

ErdosRenyi

Erdős–Rényi null model Q = 1/(2m) Σ_ij (A_ij − γ p) δ(c_i, c_j), p being the weighted density. Weights must be non-negative.

Trait Implementations

impl Clone for LeidenObjective

fn clone(&self) -> LeidenObjective

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LeidenObjective

impl Debug for LeidenObjective

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

Formats the value using the given formatter.

impl Eq for LeidenObjective

impl From<LeidenObjective> for igraph_leiden_objective_t

fn from(value: LeidenObjective) -> igraph_leiden_objective_t

Converts to this type from the input type.

impl Hash for LeidenObjective

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LeidenObjective

fn eq(&self, other: &LeidenObjective) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LeidenObjective

impl TryFrom<u32> for LeidenObjective

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: igraph_leiden_objective_t) -> Result<Self>

Performs the conversion.