Enum net_ensembles::ConfigurationModelStep

pub enum ConfigurationModelStep {
    Error,
    Added((usize, usize), (usize, usize)),
}

Markov step of configuration model

Variants

Error

step did not succeed

Added((usize, usize), (usize, usize))

• Step did succeed and can be undone using this
• contains the newly added edges, which is enough information to know which edges were removed

Tuple Fields of Added

0: (usize, usize)1: (usize, usize)

Trait Implementations

impl Clone for ConfigurationModelStep

fn clone(&self) -> ConfigurationModelStep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationModelStep

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigurationModelStep

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

Deserialize this value from the given Serde deserializer.

impl<T, R> MarkovChain<ConfigurationModelStep, Result<(), UndoStepErrorCM>> for ConfigurationModel<T, R> where
    T: Node + SerdeStateConform,
    R: Rng, 

fn m_step(&mut self) -> ConfigurationModelStep

Markov step

• use this to perform a markov step, e.g., to create a markov chain
• result ConfigurationModelStep can be used to undo the step with self.undo_step(result)

How it works

• it draws two distinct vertices, weighted with the Vertex degree
• then for each vertex a random edge is drawn from the respective adjacency list. let these edges be edge1 = (n, j) and edge2 = (k, l). These edges are removed and the edges (n, k) and (j, l) are added.
• If the above would result in an invalid topology, nothing is added or removed and ConfigurationModelStep::Error is returned

fn undo_step(
    &mut self,
    step: &ConfigurationModelStep
) -> Result<(), UndoStepErrorCM>

Undo a markcov step

• adds removed edge and removes added edge, or does nothing

Important:

Restored graph is the same as before the random step except the order of nodes in the adjacency list might be shuffled!

Error

If an error is encountered, this will revert the graph to the state, before trying to undo the step. The returned Error gives a hint for why this did not succeed.

fn undo_step_quiet(&mut self, step: &ConfigurationModelStep)

Undo a markcov step

• adds removed edge and removes added edge, or does nothing
• as long as you know, that you undo the steps in the correct order, this is the prefered method as this more efficent
• panics if an Error is encountered

fn m_steps(&mut self, count: usize, steps: &mut Vec<S, Global>)

Markov steps

fn m_steps_quiet(&mut self, count: usize)

Markov steps without return

fn m_step_acc<Acc, AccFn>(&mut self, acc: &mut Acc, acc_fn: AccFn) -> S where
    AccFn: FnMut(&Self, &S, &mut Acc), 

Accumulating markov step

fn m_steps_acc<Acc, AccFn>(
    &mut self,
    count: usize,
    steps: &mut Vec<S, Global>,
    acc: &mut Acc,
    acc_fn: AccFn
) where
    AccFn: FnMut(&Self, &S, &mut Acc), 

Accumulating markov steps

fn m_steps_acc_quiet<Acc, AccFn>(
    &mut self,
    count: usize,
    acc: &mut Acc,
    acc_fn: AccFn
) where
    AccFn: FnMut(&Self, &S, &mut Acc), 

Accumulating markov steps

fn undo_steps(&mut self, steps: &[S], res: &mut Vec<Res, Global>)

Undo markov steps

fn undo_steps_quiet(&mut self, steps: &[S])

Undo markov steps

impl Serialize for ConfigurationModelStep

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

Serialize this value into the given Serde serializer.

impl Copy for ConfigurationModelStep