Enum net_ensembles::sw::SwChangeState

pub enum SwChangeState {
    InvalidAdjecency,
    BlockedByExistingEdge,
    Nothing,
    Rewire(u32, u32, u32),
    Reset(u32, u32, u32),
    GError(GraphErrors),
}

Returned by markov steps

• information about the performed step and possible errors

Variants

InvalidAdjecency

ERROR adjecency list invalid?

BlockedByExistingEdge

Can not add edge twice

Nothing

Nothing happend

Rewire(u32, u32, u32)

old edge: (Rewire.0, Rewire.1), new edge (Rewire.0, Rewire.2)

Reset(u32, u32, u32)

old edge: (Reset.0, Reset.1), new edge (Reset.0, Reset.2)

GError(GraphErrors)

A GraphError occurred

Implementations

impl SwChangeState

pub fn is_nothing(&self) -> bool

checks if self is Nothing variant

pub fn is_nothing_or_blocked(&self) -> bool

checks if self is Nothing or BlockedByExistingEdge

pub fn not_nothing_or_blocked(&self) -> bool

result is equal to !self.is_nothing_or_blocked()

pub fn is_valid(&self) -> bool

valid states:

• SwChangeState::Rewire(..)
• SwChangeState::Reset(..)
• SwChangeState::Nothing
• SwChangeState::BlockedByExistingEdge

invalid states:

• SwChangeState::InvalidAdjecency
• SwChangeState::GError(..)

Trait Implementations

impl Debug for SwChangeState

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

Formats the value using the given formatter.

impl<T, R> MarkovChain<SwChangeState, SwChangeState> for SwEnsemble<T, R> where
    T: Node + SerdeStateConform,
    R: Rng, 

fn m_step(&mut self) -> SwChangeState

Markov step

• use this to perform a markov step
• keep in mind, that it is not unlikely for a step to do Nothing as it works by drawing an edge and then reseting it with r_prob, else the edge is rewired
• result SwChangeState can be used to undo the step with self.undo_step(result)
• result should never be InvalidAdjecency or GError if used on a valid graph

fn undo_step(&mut self, step: SwChangeState) -> SwChangeState

Undo a markov step

• rewires edge to old state
• Note: cannot undo InvalidAdjecency or GError, will just return InvalidAdjecency or GError respectively
• returns result of rewire

Important:

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

fn undo_step_quiet(&mut self, step: SwChangeState)

Undo a Monte Carlo step

• rewires edge to old state
• panics if you try to undo InvalidAdjecency or GError
• panics if rewire result (SwChangeState) is invalid (i.e. !result.is_valid())

Important:

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

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

Markov steps * use this to perform multiple markov steps at once * result Vec<S> can be used to undo the steps with self.undo_steps(result)

fn undo_steps(&mut self, steps: Vec<S>) -> Vec<Res>

Undo markov steps * Note: uses undo_step in correct order and returns result ## Important: * look at specific implementation of undo_step, every thing mentioned there applies to each step

fn undo_steps_quiet(&mut self, steps: Vec<S>)

Undo markov steps * Note: uses undo_step_quiet in correct order ## Important: * look at specific implementation of undo_step_quiet, every thing mentioned there applies to each step