Struct generations::Simulation

pub struct Simulation<Model, Step> { /* fields omitted */ }

A Simulation is a Generations instance combined with a stepping function. It allows you to repeatedly step through generations, using the same logic with each step.

It provides a step method, which advances the simulaton with the underlying stepper.

It is constructed with the Generations::with_rule method.

Methods

impl<Model, Step> Simulation<Model, Step>

#[must_use] pub fn current(&self) -> &Model

Return a reference to the current generation, which is the result of the most recent step, or the seed generation if no steps have been performed.

pub fn reset_with(&mut self, seeder: impl FnOnce(&mut Model))

Replace the current generation with a new seed generation using a function. Has no effect on the existing scratch generation. The current generation is cleared before the seed function is called.

pub fn reset(&mut self, seed: Model)

Replace the current generation with a new seed generation. Has no effect on the existing scratch generation.

pub fn unwrap(self) -> Generations<Model>

Discard the stepping function and return the underlying Generations instance

impl<Model: Clone, Step> Simulation<Model, Step>

pub fn reset_from(&mut self, seed: &Model)

Replace the current generation with a clone of a new seed generation. Has no effect on the current scratch generation.

impl<Model, Step: FnMut(&Model, &mut Model)> Simulation<Model, Step>

pub fn step(&mut self) -> &Model

Step the simulation using the stored stepping function. Returns a reference to the previously current generation.

Trait Implementations

impl<Model: Debug, Step> Debug for Simulation<Model, Step>

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

Formats the value using the given formatter.

impl<Model, Step> AsRef<Generations<Model>> for Simulation<Model, Step>

fn as_ref(&self) -> &Generations<Model>

Performs the conversion.

impl<Model: Clone, Step: Clone> Clone for Simulation<Model, Step>

fn clone(&self) -> Simulation<Model, Step>

Returns a copy of the value.

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

Performs copy-assignment from source.