Struct LeidenOptions 

pub struct LeidenOptions {
    pub objective: LeidenObjective,
    pub resolution: f64,
    pub beta: f64,
    pub n_iterations: i32,
    pub seed: u64,
    pub start: Option<Vec<u32>>,
}

Full set of options for leiden_with_options. Construct via LeidenOptions::default() and then mutate the fields you care about, mirroring the way upstream C exposes per-parameter defaults.

Fields

objective: LeidenObjective

Quality function. Default LeidenObjective::Modularity.

resolution: f64

Resolution parameter γ. Default 1.0. For CPM, sensible values are very small (e.g. 0.05); for modularity, 1.0 is the classical choice.

beta: f64

Refinement randomness. Default LEIDEN_DEFAULT_BETA.

n_iterations: i32

Number of outer iterations to run. Negative ⇒ iterate until a pass produces no change. Default LEIDEN_DEFAULT_ITERATIONS.

seed: u64

PRNG seed (drives both the local-moving shuffle and the refinement sampling). Default 0.

start: Option<Vec<u32>>

If Some, start from this membership vector instead of the singleton partition. Length must equal vcount.

Trait Implementations

impl Clone for LeidenOptions

fn clone(&self) -> LeidenOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LeidenOptions

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.