Struct CommunityDetectionConfig 

pub struct CommunityDetectionConfig {
    pub max_iterations: usize,
    pub direction: Direction,
    pub seed: Option<u64>,
    pub min_improvement: f64,
    pub max_graph_nodes: Option<usize>,
}

Configuration for Community Detection.

Fields

max_iterations: usize

Maximum number of iterations. Default: 100

direction: Direction

Direction of edges to follow. Default: Both (treat as undirected)

seed: Option<u64>

Seed for random number generation (for reproducibility). Default: None (use system entropy)

min_improvement: f64

Minimum improvement in modularity to continue iterating. Set to 0.0 to only check for label stability. Default: 0.0

max_graph_nodes: Option<usize>

Maximum number of nodes allowed before returning an error. Set to None to disable the check. Default: 10,000,000 (10M nodes)

Implementations

impl CommunityDetectionConfig

pub fn new() -> Self

Create a new configuration with default values.

pub const fn with_max_iterations(self, max_iterations: usize) -> Self

Set the maximum number of iterations.

pub const fn with_direction(self, direction: Direction) -> Self

Set the direction to follow edges.

pub const fn with_seed(self, seed: u64) -> Self

Set the seed for reproducible results.

pub const fn with_min_improvement(self, min_improvement: f64) -> Self

Set the minimum improvement threshold.

pub const fn with_max_graph_nodes(self, limit: Option<usize>) -> Self

Set the maximum number of nodes allowed.

If the graph has more nodes than this limit, the algorithm will return a GraphError::GraphTooLarge error instead of attempting to allocate potentially gigabytes of memory.

Set to None to disable the check (use with caution).

Trait Implementations

impl Clone for CommunityDetectionConfig

fn clone(&self) -> CommunityDetectionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommunityDetectionConfig

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

Formats the value using the given formatter.

impl Default for CommunityDetectionConfig

fn default() -> Self

Returns the “default value” for a type.