Struct CommunityVoronoiResult 

pub struct CommunityVoronoiResult {
    pub membership: Vec<u32>,
    pub generators: Vec<VertexId>,
    pub modularity: Option<f64>,
}

Result of community_voronoi.

membership[v] is a contiguous 0..k community id for every vertex; unreachable vertices (which can only arise in disconnected graphs and only for mode = In / Out in some configurations) keep the C reference’s behaviour and get assigned to whichever generator the underlying crate::voronoi picked.

generators is the list of vertex ids picked as Voronoi generators, in the order they were picked. Its length equals the number of distinct communities.

modularity is the Newman-Girvan modularity of membership under weights (or unit weights if weights = None), with the directness implied by mode. None for an empty graph.

Fields

membership: Vec<u32>

Community membership of each vertex (0-indexed).

generators: Vec<VertexId>

The seed (generator) vertex for each Voronoi cell.

modularity: Option<f64>

Newman-Girvan modularity; None for an empty graph.

Trait Implementations

impl Clone for CommunityVoronoiResult

fn clone(&self) -> CommunityVoronoiResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommunityVoronoiResult

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

Formats the value using the given formatter.

impl PartialEq for CommunityVoronoiResult

fn eq(&self, other: &CommunityVoronoiResult) -> 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 CommunityVoronoiResult