Skip to main content

StochasticBlockModelGenerator

oxicuda_rand::graph_gen

Struct StochasticBlockModelGenerator 

Source 
pub struct StochasticBlockModelGenerator { /* private fields */ }
Expand description

Generates random graphs with community structure according to the Stochastic Block Model.

Vertices are partitioned into blocks (communities). Within the same block, edges appear with probability intra_prob; between different blocks, with probability inter_prob.

Implementations§

Source§

impl StochasticBlockModelGenerator

Source

pub fn new( block_sizes: Vec<usize>, intra_prob: f64, inter_prob: f64, seed: u64, ) -> Self

Creates a new SBM generator.

§Arguments
  • block_sizes — sizes of each community
  • intra_prob — edge probability within communities
  • inter_prob — edge probability between communities
  • seed — PRNG seed
Source

pub fn generate(&self) -> RandResult<AdjacencyList>

Generates an undirected SBM graph.

§Errors

Returns RandError::InvalidSize if probabilities are outside [0, 1] or block_sizes is empty.

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