Struct CommunityResult

Source

pub struct CommunityResult<N: Node> {
    pub node_communities: HashMap<N, usize>,
    pub communities: Vec<HashSet<N>>,
    pub num_communities: usize,
    pub quality_score: Option<f64>,
    pub metadata: HashMap<String, f64>,
}

Expand description

Standardized result type for community detection algorithms

This type provides a unified interface for all community detection algorithms, allowing for consistent API usage and easy conversion between different representations.

Fields§

§node_communities: HashMap<N, usize>

Map from node to community ID

§communities: Vec<HashSet<N>>

The communities as sets of nodes

§num_communities: usize

Number of communities found

§quality_score: Option<f64>

Quality metric for the community structure (e.g., modularity)

§metadata: HashMap<String, f64>

Additional metadata about the communities

Implementations§

Source §

impl<N: Node + Clone + Hash + Eq> CommunityResult<N>

Source

pub fn from_node_map(_nodecommunities: HashMap<N, usize>) -> Self

Create a new CommunityResult from a node-to-community mapping

Source

pub fn from_community_structure(cs: CommunityStructure<N>) -> Self

Create from a CommunityStructure (for backward compatibility)

Source

pub fn to_community_structure(self) -> CommunityStructure<N>

Convert to the legacy CommunityStructure format

Source

pub fn as_community_sets(&self) -> &Vec<HashSet<N>>

Get communities as a vector of sets (NetworkX-style)

Source

pub fn get_community(&self, node: &N) -> Option<usize>

Get the community assignment for a specific node

Source

pub fn get_community_members(&self, communityid: usize) -> Option<&HashSet<N>>

Get all nodes in a specific community

Trait Implementations§

Source §

impl<N: Clone + Node> Clone for CommunityResult<N>

Source §

fn clone(&self) -> CommunityResult<N>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<N: Debug + Node> Debug for CommunityResult<N>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<N> UnwindSafe for CommunityResult<N>
where N: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §