Struct LouvainLevels 

pub struct LouvainLevels { /* private fields */ }

networkx’s louvain_partitions(G, ...) one generator resume at a time (br-r37-c1-81vo1): LouvainLevels::advance runs exactly the code networkx runs between two yields - a shuffle draw per _one_level - so a caller stepping it lazily, drawing from the same generator in between, sees networkx’s stream. The partition is over node positions, in the order of node_names.

Implementations

impl LouvainLevels

pub fn new<'a>( graph: impl Into<LouvainInput<'a>>, resolution: f64, weight_attr: &str, threshold: f64, sum: PythonSum, ) -> Option<Self>

The generator’s state before its first resume, read from graph as networkx reads G there. None - before any draw - where networkx would raise (a weight it cannot add, a zero or overflowing m**2) or where f64 could not follow its int arithmetic exactly (int weights whose magnitudes total 225 or more, where a degree product can pass 253); the caller runs networkx then.

pub fn advance(&mut self, rng: Option<&mut MT19937>) -> bool

One generator resume: true with the next partition in Self::partition, false once networkx’s generator would raise StopIteration.

pub fn partition(&self) -> &[Vec<usize>]

The partition the last Self::advance yielded, as node positions (each community in ascending order).

pub fn moves(&self) -> &[LouvainMove]

The moves of the level the last Self::advance yielded, in the order networkx makes them (none for the singletons of an edgeless graph). networkx’s yielded sets are its partition’s after every move of every level so far, so their iteration order is this history’s: a caller replaying it on real sets (br-r37-c1-ygt3z) gets networkx’s.

pub fn node_names(&self) -> &[String]

The graph’s node names, in position order.

Trait Implementations

impl Clone for LouvainLevels

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LouvainLevels

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

Formats the value using the given formatter.