Enum net_ensembles::er_c::ErStepC

pub enum ErStepC {
    Nothing,
    AddedEdge((u32, u32)),
    RemovedEdge((u32, u32)),
    GError(GraphErrors),
}

Returned by markov steps

Variants

Nothing

nothing was changed

AddedEdge((u32, u32))

an edge was added

RemovedEdge((u32, u32))

an edge was removed

GError(GraphErrors)

a GraphError occured and is wrapped here

Implementations

impl ErStepC

pub fn is_valid(&self) -> bool

true if self is not GError variant

pub fn valid_or_panic(&self)

panic! if self is GError variant

pub fn valid_or_panic_msg(&self, msg: &str)

panic!(msg) if self is GError variant

Trait Implementations

impl Clone for ErStepC

fn clone(&self) -> ErStepC

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErStepC

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

Formats the value using the given formatter.

impl<T, R> MarkovChain<ErStepC, ErStepC> for ErEnsembleC<T, R> where
    T: Node + SerdeStateConform,
    R: Rng, 

fn m_step(&mut self) -> ErStepC

Markov step

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

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

Undo a markcov step

• adds removed edge, or removes added edge, or does nothing
• if it returns an Err value, you probably used the function wrong

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: ErStepC)

Undo a markov step

• adds removed edge, or removes added edge, or does nothing
• if it returns an Err value, you probably used the function wrong

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