Struct LeidenOptions 

pub struct LeidenOptions<'a> {
    pub resolution: f64,
    pub beta: f64,
    pub iterations: Option<u32>,
    pub initial: Option<&'a [i64]>,
}

Options of Graph::community_leiden and Graph::community_leiden_simple.

Fields

resolution: f64

Resolution parameter γ (default 1.0). Note that for the raw Graph::community_leiden interface, modularity is obtained with degrees as vertex weights and γ = 1 / (2m).

beta: f64

Randomness in the refinement step (default 0.01).

iterations: Option<u32>

Number of iterations of the core algorithm (default Some(2)); None iterates until an iteration does not change the partition.

initial: Option<&'a [i64]>

Starting partition (default None: singletons).

Implementations

impl<'a> LeidenOptions<'a>

pub fn with_resolution(self, resolution: f64) -> Self

Sets the resolution parameter.

pub fn with_beta(self, beta: f64) -> Self

Sets the refinement randomness beta.

pub fn with_iterations(self, iterations: Option<u32>) -> Self

Sets the number of iterations (None: until convergence).

pub fn with_initial(self, initial: &'a [i64]) -> Self

Sets the starting partition.

Trait Implementations

impl<'a> Clone for LeidenOptions<'a>

fn clone(&self) -> LeidenOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LeidenOptions<'a>

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

Formats the value using the given formatter.

impl Default for LeidenOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for LeidenOptions<'a>

fn eq(&self, other: &LeidenOptions<'a>) -> 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<'a> StructuralPartialEq for LeidenOptions<'a>