Skip to main content

LeadingEigenvector

Struct LeadingEigenvector 

Source
pub struct LeadingEigenvector {
    pub membership: Vec<i64>,
    pub merges: Vec<(i64, i64)>,
    pub modularity: f64,
    pub eigenvalues: Vec<f64>,
    pub eigenvectors: Vec<Vec<f64>>,
    pub history: Vec<LeadingEigenvectorEvent>,
}
Expand description

Result of Newman’s leading eigenvector method, see Graph::community_leading_eigenvector.

Fields§

§membership: Vec<i64>

Community id of each vertex after all the splits.

§merges: Vec<(i64, i64)>

The splits, replayed backwards as merges of community ids (not vertex ids): with p final communities, the first pair forms community p, the second p + 1, … Use le_community_to_membership to undo splits.

§modularity: f64

Modularity of the final division.

§eigenvalues: Vec<f64>

Eigenvalue computed at each step (NaN for steps given by the initial partition); non-positive values did not result in a split.

§eigenvectors: Vec<Vec<f64>>

Eigenvector computed at each step, restricted to the vertices of the community being split (empty for steps given by the initial partition).

§history: Vec<LeadingEigenvectorEvent>

A trace of the algorithm.

Implementations§

Source§

impl LeadingEigenvector

Source

pub fn num_communities(&self) -> usize

Number of communities in membership.

Source

pub fn sizes(&self) -> Vec<usize>

Size of each community, indexed by community id.

Source

pub fn communities(&self) -> Vec<Vec<VertexId>>

The vertices of each community, indexed by community id.

Trait Implementations§

Source§

impl Clone for LeadingEigenvector

Source§

fn clone(&self) -> LeadingEigenvector

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 LeadingEigenvector

Source§

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

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

impl PartialEq for LeadingEigenvector

Source§

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

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, 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.