Skip to main content

LeidenPartition

Struct LeidenPartition 

Source
pub struct LeidenPartition {
    pub assignments: BTreeMap<usize, usize>,
    pub stability: BTreeMap<usize, f64>,
    pub modularity: f64,
    pub seed: u64,
}
Expand description

Leiden community detection result — re-exported from sdivi-detection for WASM embedders. The result of a Leiden community detection run.

Community IDs are stable integers starting at zero, assigned in ascending order of the lowest node index within each community. This guarantees deterministic JSON output given the same input graph and seed.

§Examples

use sdivi_detection::partition::LeidenPartition;
use std::collections::BTreeMap;

let p = LeidenPartition {
    assignments: BTreeMap::from([(0, 0), (1, 0), (2, 1)]),
    stability: BTreeMap::from([(0, 0.8), (1, 1.0)]),
    modularity: 0.42,
    seed: 42,
};
assert_eq!(p.assignments[&0], 0);
assert_eq!(p.community_count(), 2);

Fields§

§assignments: BTreeMap<usize, usize>

Node index → community ID.

§stability: BTreeMap<usize, f64>

Community ID → stability score (internal edge density, [0, 1]).

§modularity: f64

Overall modularity of the final partition.

§seed: u64

Seed used to produce this partition.

Implementations§

Source§

impl LeidenPartition

Source

pub fn community_count(&self) -> usize

Number of communities in the partition.

Source

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

Returns the community ID for node index node.

Source

pub fn largest_community_size(&self) -> usize

Returns the file path associated with the largest community (most nodes).

Source

pub fn communities(&self) -> BTreeMap<usize, Vec<usize>>

Groups node indices by community, sorted for determinism.

Source

pub fn to_json(&self) -> Result<String, Error>

Serialises the partition to compact JSON.

Source

pub fn from_json(json: &str) -> Result<LeidenPartition, Error>

Deserialises a partition from JSON.

Trait Implementations§

Source§

impl Clone for LeidenPartition

Source§

fn clone(&self) -> LeidenPartition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LeidenPartition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for LeidenPartition

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<LeidenPartition, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for LeidenPartition

Source§

fn eq(&self, other: &LeidenPartition) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for LeidenPartition

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for LeidenPartition

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,