pub struct StochasticBlockModel {
pub config: StochasticBlockModelConfig,
}Expand description
The Stochastic Block Model.
Fields§
§config: StochasticBlockModelConfigConfiguration.
Implementations§
Source§impl StochasticBlockModel
impl StochasticBlockModel
Sourcepub fn new(config: StochasticBlockModelConfig) -> Self
pub fn new(config: StochasticBlockModelConfig) -> Self
Create a new SBM with the given configuration.
Sourcepub fn fit(&self, graph: &AdjacencyGraph) -> Result<SBMResult>
pub fn fit(&self, graph: &AdjacencyGraph) -> Result<SBMResult>
Fit the SBM to the observed adjacency graph.
If config.num_blocks is set, fits with that K.
Otherwise, tries each K in config.k_range and picks the one
with the best ICL score.
Sourcepub fn predict(
&self,
graph: &AdjacencyGraph,
b_matrix: &[f64],
k: usize,
) -> Result<Vec<usize>>
pub fn predict( &self, graph: &AdjacencyGraph, b_matrix: &[f64], k: usize, ) -> Result<Vec<usize>>
Predict block assignments for a given graph using a fitted model.
This re-runs the E-step with the given B matrix to assign labels.
Sourcepub fn generate(
n: usize,
k: usize,
b_matrix: &[f64],
block_sizes: &[usize],
seed: u64,
) -> Result<(AdjacencyGraph, Vec<usize>)>
pub fn generate( n: usize, k: usize, b_matrix: &[f64], block_sizes: &[usize], seed: u64, ) -> Result<(AdjacencyGraph, Vec<usize>)>
Generate a random graph from SBM parameters.
n: number of nodesk: number of blocksb_matrix: K x K probability matrix (row-major)block_sizes: sizes of each block (must sum to n)
Trait Implementations§
Source§impl Clone for StochasticBlockModel
impl Clone for StochasticBlockModel
Source§fn clone(&self) -> StochasticBlockModel
fn clone(&self) -> StochasticBlockModel
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for StochasticBlockModel
impl Debug for StochasticBlockModel
Source§impl<'de> Deserialize<'de> for StochasticBlockModel
impl<'de> Deserialize<'de> for StochasticBlockModel
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for StochasticBlockModel
impl RefUnwindSafe for StochasticBlockModel
impl Send for StochasticBlockModel
impl Sync for StochasticBlockModel
impl Unpin for StochasticBlockModel
impl UnsafeUnpin for StochasticBlockModel
impl UnwindSafe for StochasticBlockModel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.